Node.JS 클래스 주석 추출

Question

내가 작업하고있는 Node.JS 프로젝트가 있는데이 프로젝트의 특정 기능은 디렉토리의 모든 JS 파일을 읽고 클래스 주석 (클래스 이름 이 정보를 객체 배열에 저장하여 나중에 markdown으로 변환 할 수도 있습니다.

제 질문은 입니다. 클래스 이름과 클래스 주석과 같은 구성 요소를 추출하는 가장 좋은 방법은 무엇입니까?

필자는 파일을 읽고 구문을 파싱하는 것에 대해 생각해 보았지만 왜 바퀴를 다시 만들 생각입니까? 특정 주석을 추출하기위한 좋은 도구 나 JS 파일을 구문 분석하는 영리한 알고리즘이 있다면 그 파일을 듣고 싶습니다. 감사!

Answer 1

이러한 libs와 중 하나를 시도 할 수 있습니다 :

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 웹 페이지는 일만큼 간단합니다 제안

npm i -g jsdoc 
jsdoc yourFile.js 

그리고이 꿀꿀/꿀꺽와 결합 될 수있다 물론

...