Fetch the repository succeeded.
将注释转换成文档的demo
可以将src目录下的js文件中的注释转成对应的文档。比如如下文件代码（见src目录）：
export class Example1 {
/**
* @apiAnalyze
* @apiPath Example1=>method1
* @apiDesc 例1方法1
*/
method1 () {
// do sth.
}
/**
* @apiAnalyze
* @apiPath Example1=>method2
* @apiDesc 例1方法2
*/
method2 () {
// do sth.
}
}
会被转换成下面这样的文档内容（markdown格式，见documents-api目录）：
# /example1.js文件注释生成的文档
## 一、目录
1. Example1=>method1: 例1方法1
2. Example1=>method2: 例1方法2
## 二、详情
|方法|描述|
|---|----|
|Example1=>method1|例1方法1|
|Example1=>method2|例1方法2|
Sign in to post a comment
Repository Comments ( 0 )