1 Star 0 Fork 0

牛气腾腾 / comment-to-doc

Create your Gitee Account
Explore and code with more than 8 million developers,Free private repositories !:)
Sign up
The current repository's web page is accessible only to members. If you need to make it public, please ask author Yakima to submit applications.
Clone or Download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

comment-to-doc

介绍

将注释转换成文档的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|

License

MIT

Repository Comments ( 0 )

Sign in to post a comment

About

将注释转换成文档的demo expand collapse
NodeJS
MIT
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
NodeJS
1
https://gitee.com/bulls-cows/comment-to-doc.git
git@gitee.com:bulls-cows/comment-to-doc.git
bulls-cows
comment-to-doc
comment-to-doc
master

Search

103111 552b83b3 1850385 103110 ed87a847 1850385