# icedoc

**Repository Path**: iceroot/icedoc

## Basic Information

- **Project Name**: icedoc
- **Description**: icedoc
icedoc是一个无侵入的生成接口文档的工具,使用它无需修改原始代码,即可生成.

icedoc is a non-intrusive tool for generating interface documents that can be generated without using the original code.

- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2017-10-03
- **Last Updated**: 2022-11-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# icedoc
icedoc
icedoc是一个无侵入的生成接口文档的工具,使用它无需修改原始代码,即可生成.

使用说明:
com.icedoc.main.Main是入口方法,
需要修改folder为你需要扫描的项目的根路径,
需要修改folderOut为你生成的接口文档的根路径.

以下内容为可以修改的,也可以不修改.
/icedoc/src/conf.txt文件指定工程相关配置.
title是doc文档中的文件标题
version是doc文档的版本.
author是文档作者.
/icedoc/src/param.txt指定常用的url输入参数名称.
Controller方法上面的中文注释将被自动识别.
返回类型的参数由于需要在运行时才能知道,所以未给出返回值生成.
但是如果返回一个对象,那么对象第一层属性的参数将被生成,属性每行后面的注释作为返回值的注释.

icedoc
icedoc is a non-intrusive tool for generating interface documents that can be generated without using the original code.

Instructions for use:
com.icedoc.main.Main is the entry method,
Need to modify the folder for the root path of the project you need to scan,
You need to modify the root path of the interface document that you created for folderOut.

The following can be modified, you can not modify.
The /icedoc/src/conf.txt file specifies the project-related configuration.
title is the file title in the doc document
version is the version of the doc document.
author is the author of the document.
/icedoc/src/param.txt Specifies the common url input parameter name.
The Chinese comments above the Controller method will be automatically recognized.
The return type parameter is not generated because it needs to be known at run time.
However, if an object is returned, the parameters of the first layer attribute of the object will be generated, and the comment after each line will be a comment of the return value.