Node.JSクラスのコメントを抽出する

Question

私は作業中のNode.JSプロジェクトを持っていますが、その非常に特定の機能はディレクトリ内のすべてのJSファイルを読み込み、クラスコメント（おそらくクラス名あとでこの情報をオブジェクトの配列に格納し、後でマークダウンに変換します）。

私の質問はです。クラス名やクラスコメントなど、これらのコンポーネントを抽出する最も良い方法は何ですか？

私はファイルを読み、構文を解析することについて考えましたが、なぜ車輪を再発明するのですか？特定のコメントを抽出するための優れたツールや、JSファイルの解析のための巧妙なアルゴリズムがある場合は、そのファイルを聞きたいと思います。ありがとう！

Answer 1

あなたはこれらのlibsの1試すことができます。

https://www.npmjs.com/package/parse-comments

https://www.npmjs.com/package/js-comments

https://www.npmjs.com/package/elsen-js-comments

Answer 2

はabstract syntax treeにあなたのコードを変換パーサに見てください。

たとえば、Esprimaは、ES6 JavaScriptを解析して識別子とコメントを抽出するのに役立ちます。

this live demoをご覧ください。次のクラスの場合は、以下のASTが生成されます。

/** 
* 
* This is a test class 
* 
*/ 
class Foo { 
    bar() { 
     console.log('foobar'); 
    } 
} 

---

{ 
    "type": "Program", 
    "body": [ 
     { 
      "type": "ClassDeclaration", 
      "id": { 
       "type": "Identifier", 
       "name": "Foo" 
      }, 
      "superClass": null, 
      "body": { 
         ... 
        } 
       ] 
      }, 
      "leadingComments": [ 
       { 
        "type": "Block", 
        "value": "*\n *\n * This is a test class\n *\n ", 
        "range": [ 
         0, 
         37 
        ] 
       } 
      ] 
     } 
    ], 
    "sourceType": "script" 
} 

Answer 3

まさにこれを行うツールがあります！ jsDocをチェックしてください。コメントから https://github.com/jsdoc3/jsdoc

ビルのHTMLウェブページやってするのと同じくらい簡単です：...提案のため