JSソースファイルのドキュメントコメントと抽出

ドキュメントの開発は価値がありますが、ドキュメントの作成と更新は容易ではありません.
JAVAにはjavadocツールがあり、コメントをワンクリックで抽出してドキュメントを生成できます.他の言語では、必ずしも便利ではありません.
ここではjavascriptファイルの注釈を抽出し、美しいhtmlドキュメントを生成するツールを紹介します.
jsdocは、@author、@param、@methodなどのJAVAに類似したコメントラベルを識別する.例:

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 */
function Book(title, author) {
}

プロファイルを使用すると、以下のオプションを追加できます.

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false
    }
}

ディレクトリの再帰操作がサポートされていることがわかります.
カスタムテンプレートを指定することで、ドキュメントをオンデマンドで生成できます.さらに詳細な構成では、こことコマンドラインパラメータを表示できます.
jsdocのインストール:

インストールNodejs

コマンドラインの下にjsdocパッケージをインストール:npm install -g jsdoc

詳細:markdownドキュメントの生成
実際にはmarkdownドキュメントを直接生成することもできます.ここでは、jsdoxという別のツールパッケージをインストールする必要があります.
使用法は次のとおりです.

    jsdox [options] <file | directory>
    jsdox --All --output docs folder/file

Options:
  -c, --config  <file>         
  -A, --All                         ，      
  -d, --debug                      
  -H, --help                 
  -v, --version                
  -o, --output                 
  -t, --templateDir            

同様にjsdoxは、単一のファイルのコメントを抽出したり、ディレクトリ別に抽出したりすることができます.