1 Star 0 Fork 0

牛气腾腾 / comment-to-doc

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md
MIT

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

MIT License Copyright (c) 2021 Yakima Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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