JSDoc은 JavaScript 소스 코드 파일에 주석을 추가하는 데 사용되는 마크업 언어 입니다 . 프로그래머는 JSDoc이 포함된 주석을 사용하여 자신이 만들고 있는 코드의 애플리케이션 프로그래밍 인터페이스를 설명하는 문서를 추가할 수 있습니다. 그런 다음 이를 다양한 도구로 처리하여 HTML 및 서식 있는 텍스트 형식 과 같은 액세스 가능한 형식으로 문서를 생성합니다 . JSDoc 사양은 CC BY-SA 3.0 에 따라 출시되며 동반 문서 생성기 및 파서 라이브러리는 Apache 라이선스 2.0 에 따라 무료 소프트웨어 입니다 .
- @author 개발자 이름
- @constructor 함수를 생성자로 표시
- @deprecated 더 이상 사용되지 않는 것으로 표시
- @exception 동의어@throws
- @exports 모듈에서 내보낸 멤버를 식별합니다.
- @param 메소드 매개변수를 문서화합니다. 중괄호 사이에 데이터 유형 표시기를 추가할 수 있습니다.
- @private 멤버가 비공개임을 나타냅니다.
- @returns 반환 값 문서화
- @return 동의어@returns
- @see 다른 개체에 대한 연결을 문서화합니다.
- @todo 누락된/열린 것을 문서화합니다.
- @this this함수 내에서 키워드가 참조하는 개체의 유형을 지정합니다 .
- @throws 메서드에 의해 발생한 예외를 문서화합니다.
- @version 라이브러리의 버전 번호를 제공합니다.
To Infinity and Beyond