JSDoc

JSDoc
초기 릴리즈1999년; 23년 전(1999년)
최신 릴리즈
3.6.3
2019년 7월 15일, 3년 전(2019-07-15)
포맷의 종류프로그래밍 문서 형식
포함자JavaScript 원본 파일
확장원Java Doc
오픈 포맷?네.
웹 사이트jsdoc.app

JSDoc은 JavaScript 소스 코드 파일에 주석을 달기 위해 사용되는 마크업 언어입니다.프로그래머는 JSDoc을 포함한 코멘트를 사용하여 작성 중인 코드의 애플리케이션 프로그래밍 인터페이스를 설명하는 문서를 추가할 수 있습니다.그런 다음 다양한 도구에 의해 처리되어 HTML 및 리치 텍스트 형식과 같은 접근 가능한 형식으로 문서를 작성합니다.JSDoc 사양은 CC BY-SA 3.0으로 출시되며 부속 문서 생성기와 파서 라이브러리는 Apache License 2.0으로 무료 소프트웨어입니다.

역사

JSDoc의 구문 및 의미론은 Java로 작성된 코드를 문서화하는 데 사용되는 Javadoc 체계와 유사합니다.JSDoc은 Javadoc과 [1]달리 JavaScript의 동적 동작을 처리하는 데 특화되어 있습니다.

Javadoc과 유사한 구문을 사용하여 JavaScript를 문서화하는 초기 예는 1999년에 Java로 작성된 JavaScript 런타임 시스템인 Netscape/Mozilla 프로젝트 Rhino와 함께 공개되었습니다.자바스크립트 기능의 [2]예로서 1.3까지 버전화된 완구 "JSDoc" HTML 생성기가 포함되어 있었다.

"JSDoc"의 모든 주요 세대는 micmaths(마이클 매튜스)가 이끌었다.그는 2001년 캐나다 프로그래머 가브리엘 리드와 협력하여 Perl로 작성된 간단한 시스템인 JSDoc.pm을 시작했다.CVS [3]저장소의 SourceForge에서 호스트되었습니다.JSDoc 1.0(2007)에 의해 그는 JavaScript(Rhino용)로 시스템을 다시 작성하였고 일련의 확장 후에 JSDoc 2.0(2008)은 "jsdoc-toolkit"이라는 이름을 얻었다.MIT 라이센스에 따라 출시된 이 버전은 Google 코드의 [4]Subversion 저장소에 호스팅되었습니다.2011년까지 그는 시스템을 JSDoc 3.0으로 리팩터링하여 GitHub에서 결과를 호스트했습니다.이제 Node.[1]js에서 실행됩니다.

JSDoc 태그

현대 JSDoc에서 사용되는 주석 태그는 다음과 같습니다.

태그 묘사
@author 개발자명
@constructor 함수를 생성자로 표시합니다.
@deprecated 메서드를 권장되지 않음으로 표시합니다.
@exception 의 동의어@throws
@exports 모듈에 의해 내보내는 멤버를 식별합니다.
@param 메서드 매개 변수를 문서화합니다. 데이터 유형 표시기는 중괄호 사이에 추가할 수 있습니다.
@private 멤버가 비공개임을 나타냅니다.
@returns 반환값을 문서화합니다.
@return 의 동의어@returns
@see 다른 오브젝트와의 연관성을 문서화합니다.
@todo 누락된 것/열린 것을 문서화합니다.
@this 키워드의 대상이 되는 객체의 유형을 지정합니다.this함수 내를 참조합니다.
@throws 메서드에 의해 발생한 예외를 문서화합니다.
@version 라이브러리의 버전 번호를 제공합니다.

예

/** @class Circle은 원을 나타냅니다.*/ 학급 원형 { /** * 원의 인스턴스를 만듭니다. * * @author: moi * @param {number} r 원의 원하는 반지름. */   컨스트럭터(r) {     /** @private */ 이것..반지름 = r     /** @private */ 이것..둘레 = 2 * 수학.PI * r   }    /** * 직경에서 새 원을 만듭니다. * * @param {number} d 원하는 원의 지름입니다. * @return {Circle} 새 Circle 개체입니다. */   정적인 직경에서(d) {     돌아가다 신규 원형(d / 2)   }    /** * 원의 둘레를 계산합니다. * * @1.1.0 이후 폐지되었습니다.대신 getCircumference를 사용합니다. * @return {number} 원의 둘레입니다. */   calculate Circumference(계산원)() {     돌아가다 2 * 수학.PI * 이것..반지름   }    /** * 미리 계산된 원의 둘레를 반환합니다. * * @return {number} 원의 둘레입니다. * 1.1.0 이후 */   getCircumference() {     돌아가다 이것..둘레   }    /** * 원의 문자열 표현을 찾습니다. * * @parames(@paramic) * @return {string} 사람이 읽을 수 있는 이 원의 표현입니다. */   문자열() {     돌아가다 "[반경을 가진 원 모양의 물체]${이것..반지름}.]`   } }  /** * 원을 인쇄합니다. * * @param {Circle}원 */ 기능. print Circle(원)(원형) {     /** @ 이 {Circle} */     기능. 바운드() { 콘솔.로그.(이것.) }     바운드.적용합니다.(원형) }

주의:@class그리고.@constructor태그는 생략할 수 있습니다.ECMASyntax는 ID를 명확히 하기 위해 충분하며 JSDoc은 이를 [5]사용합니다. @override자동으로 [6]추론할 수도 있습니다.

JSDoc 사용 중

  • Google의 Closure Linter 및 Closure 컴파일러.후자는 출력 JavaScript를 최적화하기 위해 유형 정보를 추출합니다.
  • TypeScript는 JSDoc 유형의 [7]주석을 사용하여 JavaScript 파일의 유형 검사를 수행할 수 있습니다.Microsoft는 확장 가능한 태그를 가진 새로운 TSDoc 언어를 지정했습니다.
  • 인기 에디터 Sublime Text는 DocBlockr 또는 DoxyDoxygen 플러그인을 통해 JSDoc을 지원합니다.
  • JSDoc 구문은 Apress 책 Foundations of Ajax에 자세히 설명되어 있습니다. ISBN1-59059-582-3.
  • IntelliJ IDEA, NetBeans, Visual Studio Code 및 RubyMine은 JSDoc 구문을 이해합니다.
  • Eclipse 기반의 Aptana Studio는 ScriptDoc을 지원합니다.
  • Mozilla Inline Editor는 JSDoc.pm을 사용합니다.
  • Helma 애플리케이션 프레임워크는 JSDoc을 사용합니다.
  • SprootCore 문서는 JSDoc을 사용하여 생성되었습니다.[ 1 ]
  • Visual Studio, WebStorm 및 기타 많은 통합 개발 환경 또는 텍스트 편집기는 JSDoc 의견을 기반으로 코드 완성 및 기타 지원을 제공합니다.
  • 오픈 소스 ATOM 에디터는 atom-easy-jsdoc 플러그인을 통해 JSDoc을 지원합니다.

「 」를 참조해 주세요.

레퍼런스

  1. ^ a b "JSDoc". GitHub. jsdoc. 4 September 2019. Retrieved 4 September 2019.
  2. ^ "Rhino example: jsdoc.js". GitHub. Mozilla project. May 6, 1999.
  3. ^ "JSDoc". SourceForge. Git 변환
  4. ^ "jsdoc-toolkit". Google Code. Git 변환
  5. ^ "ES 2015 Classes". Use JSDoc.
  6. ^ "@override". Use JSDoc.
  7. ^ "Type Checking JavaScript Files". TypeScript Documentation.

외부 링크