JSDOC
함수와 매개변수 정보를 담고 있는 주석 자바에는 JAVADOC이 있다.
Use JSDoc: Index
Index Getting Started Getting Started with JSDoc 3 A quick-start to documenting JavaScript with JSDoc. Using namepaths with JSDoc 3 A guide to using namepaths with JSDoc 3. Command-line arguments to JSDoc About command-line arguments to JSDoc. Configuring
jsdoc.app
@author
작성자 식별
@version
라이브러리 버전 정보
@copyright
파일 개요, 설명에 대한 저작권 정보 (w.@file)
@file (@fileoverview, @overview)
파일에 대한 설명
@license
소프트웨어 라이센스
표준 오픈소스 라이브러리 식별자(identifier) 입력 https://spdx.org/licenses/
@this
해당 함수내부의 this가 참조하는 것을 표시
@constant (@const)
상수를 표시
@description (@desc)
설명을 표시
@throws (@exception)
메서드에 의해 발생된 오류나 예외사항을 표시
단일 주석에 두 번 포함하지 말 것
@param (@arg, @argument)
함수에 전달받은 인자 값의 이름
유형 및 설명을 표시
@callback
콜백으로 받은 인자 및 반환 값에 대한 정보 제공
@return (@returns)
함수가 반환하는 값을 표시
출처: https://okayoon.tistory.com/entry/JSDoc를-사용해서-Javasript-문서화해보자 [Zzolab Blog :)]
JSDoc를 사용해서 Javasript 문서화해보자!
들어가기전에... 신규프로젝트가 있어서 산출물 작업때 JSDoc을 사용하려고 생각했는데, 프로젝트에서 JSDoc을 사용하지 않게되어 ㅎㅎ 개인적으로 정리하여 작성합니다. 그냥 이런저런 주석이 있
okayoon.tistory.com
