색인

시작하기

JSDoc 3로 시작하기

JSDoc로 JavaScript 문서화를 위한 빠른 시작.

JSDoc 3에서 네임패스 사용하기

JSDoc 3와 함께 네임패스를 사용하는 방법에 대한 가이드.

JSDoc에 대한 명령줄 인수

JSDoc에 대한 명령줄 인수에 대한 정보.

구성 파일로 JSDoc 구성하기

구성 파일을 사용하여 JSDoc을 구성하는 방법.

JSDoc의 기본 템플릿 구성하기

JSDoc의 기본 템플릿에서 출력 구성을 설정하는 방법.

블록 및 인라인 태그

블록 및 인라인 JSDoc 태그에 대한 개요.

JSDoc 플러그인에 대하여

JSDoc 플러그인을 만드는 방법과 사용하는 방법.

마크다운 플러그인 사용하기

JSDoc에서 마크다운 지원을 활성화합니다.

튜토리얼

API 문서에 튜토리얼 추가하기.

패키지 파일 포함하기

문서에서 패키지 세부정보를 표시하는 방법.

README 파일 포함하기

문서에 README 파일을 포함하는 방법.

라이센스

JSDoc 3에 대한 라이센스 정보.

JSDoc 예제

ES 2015 클래스

ECMAScript 2015 클래스에 JSDoc 주석 추가하기.

ES 2015 모듈

ECMAScript 2015 모듈에 JSDoc 주석 추가하기.

CommonJS 모듈

CommonJS 및 Node.js 모듈에 JSDoc 주석 추가하기.

AMD 모듈

AMD 및 RequireJS 모듈에 JSDoc 주석 추가하기.

블록 태그

@abstract (동의어: @virtual)

이 구성원은 상속자가 구현(또는 재정의)해야 합니다.

@access

이 구성원의 접근 수준을 지정합니다(비공개, 패키지-비공식, 공개 또는 보호됨).

@alias

구성원을 다른 이름으로 취급합니다.

@async

함수가 비동기적임을 나타냅니다.

@augments (동의어: @extends)

기호가 부모 기호에서 상속하고 추가됨을 나타냅니다.

@author

항목의 저자를 식별합니다.

@borrows

이 객체는 다른 객체에서 무언가를 사용합니다.

@callback

콜백 함수를 문서화합니다.

@class (동의어: @constructor)

이 함수는 "new" 키워드와 함께 호출될 예정입니다.

@classdesc

전체 클래스를 설명하는 데 사용할 텍스트를 제공합니다.

@constant (동의어: @const)

객체를 상수로 문서화합니다.

@constructs

이 함수 구성원은 이전 클래스의 생성자가 됩니다.

@copyright

저작권 정보를 문서화합니다.

@default (동의어: @defaultvalue)

기본값을 문서화합니다.

@deprecated

더 이상 권장되지 않음을 문서화합니다.

@description (동의어: @desc)

기호에 대한 설명을 제공합니다.

@enum

연관된 속성의 컬렉션을 문서화합니다.

@event

이벤트를 문서화합니다.

@example

문서화된 항목을 사용하는 방법의 예시를 제공합니다.

@exports

JavaScript 모듈에 의해 내보내지는 구성원을 식별합니다.

@external (동의어: @host)

외부 클래스, 네임스페이스 또는 모듈을 식별합니다.

@file (동의어: @fileoverview, @overview)

파일을 설명합니다.

@fires (동의어: @emits)

이 메소드에서 발생할 수 있는 이벤트를 설명합니다.

@function (동의어: @func, @method)

함수 또는 메소드를 문서화합니다.

@generator

함수가 생성기 함수임을 나타냅니다.

@global

전역 객체를 문서화합니다.

@hideconstructor

생성자를 표시하지 않아야 함을 나타냅니다.

@ignore

문서에서 기호를 생략합니다.

@implements

이 기호는 인터페이스를 구현합니다.

@inheritdoc

이 기호가 부모의 문서를 상속해야 함을 나타냅니다.

@inner

내부 객체를 문서화합니다.

@instance

인스턴스 구성원을 문서화합니다.

@interface

이 기호는 다른 사람들이 구현할 수 있는 인터페이스입니다.

@kind

이 기호는 어떤 유형인가요?

@lends

기호가 주어진 이름을 가진 객체 리터럴의 속성으로 문서화합니다.

@license

이 코드에 적용되는 라이센스를 식별합니다.

@listens

기호가 수신하는 이벤트 목록을 나열합니다.

@member (동의어: @var)

구성원을 문서화합니다.

@memberof

이 기호는 부모 기호에 속합니다.

@mixes

이 객체는 다른 객체의 모든 구성원을 혼합합니다.

@mixin

믹스인 객체를 문서화합니다.

@module

JavaScript 모듈을 문서화합니다.

@name

객체의 이름을 문서화합니다.

@namespace

네임스페이스 객체를 문서화합니다.

@override

이 기호가 부모를 재정의해야 함을 나타냅니다.

@package

이 기호는 패키지-비공식으로 되어 있습니다.

@param (동의어: @arg, @argument)

함수의 매개변수를 문서화합니다.

@private

이 기호는 비공개로 되어 있습니다.

@property (동의어: @prop)

객체의 속성을 문서화합니다.

@protected

이 기호는 보호됨으로 되어 있습니다.

@public

이 기호는 공개됨으로 되어 있습니다.

@readonly

이 기호는 읽기 전용으로 되어 있습니다.

@requires

이 파일은 JavaScript 모듈을 요구합니다.

@returns (동의어: @return)

함수의 반환값을 문서화합니다.

@see

더 많은 정보를 위해 다른 문서를 참조합니다.

@since

이 기능이 언제 추가되었나요?

@static

정적 구성원을 문서화합니다.

@summary

전체 설명의 짧은 버전입니다.

@this

여기에서 'this' 키워드는 무엇을 참조합니까?

@throws (동의어: @exception)

발생할 수 있는 오류를 설명합니다.

@todo

완료해야 할 작업을 문서화합니다.

@tutorial

포함된 튜토리얼 파일에 대한 링크를 삽입합니다.

@type

객체의 유형을 문서화합니다.

@typedef

사용자 정의 유형을 문서화합니다.

@variation

같은 이름을 가진 다른 객체를 구분합니다.

@version

항목의 버전 번호를 문서화합니다.

[@yields](