# nani-doc

**Repository Path**: luoye/nani-doc

## Basic Information

- **Project Name**: nani-doc
- **Description**: 基于java doc注释生成文档，零侵入。


- **Primary Language**: Java
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-02-07
- **Last Updated**: 2022-06-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NaNi Doc（纳尼文档）

基于java doc注释生成文档，零侵入。

## 快速开始

源码目录启动

```shell
curl -L https://s.lmm.show/nani-doc/run.sh | bash -s -- -package show.lmm.controller -sourceJars "./libs/sources/commonBase-2.1.1-sources.jar,./libs/sources/spring-web-5.3.13-sources.jar" -wraperClasses "reactor.core.publisher.Mono"
```

## 📖 命令行参数

| 参数名           | 是否必填 | 标题           | 描述               | 示例                          |
|---------------|------|--------------|------------------|-----------------------------|
| package       | √    | controller包名 |                  | show.lmm.controller         |
| sourceJars    | ×    | 第三方源码jar包列表  | 多个以英文逗号分割        | c:/a.jar,d:/b.jar           |
| sourcePath    | ×    | 源码目录         | 默认为当前目录          |                             |
| docOutPath    | ×    | 文档输出目录       | 默认为：./distDoc 目录 |                             |
| wraperClasses | ×    | 包裹class列表    | 默认为空，多个以英文逗号分割   | reactor.core.publisher.Mono |

## 💿 调用示例

```shell
java -jar .\nani-doc-1.0.jar -package show.lmm.controller -sourceJars "./libs/sources/commonBase-2.1.1-sources.jar,./libs/sources/spring-web-5.3.13-sources.jar" -wraperClasses "reactor.core.publisher.Mono" -sourcePath "D:\project\testProject"
```