構文
JSDoc 태그 사전(일반적으로 활성화)을 사용하여
@package
Closure 컴파일러 태그 사전을 사용하여
@package [{typeExpression}]
개요
@package 태그는 패키지-비공개로 기호를 표시합니다. 이 태그는 일반적으로 이 기호의 소스 파일과 같은 디렉토리의 코드에 대해서만 기호를 사용할 수 있음을 나타냅니다. 이 태그는 JSDoc 3.5.0 이상에서 사용할 수 있습니다.
일반적으로 @package 태그로 표시된 기호는 문서에 나타납니다. JSDoc 3.3.0 이상에서는 -a/--access 명령줄 옵션을 사용하여 이 동작을 변경할 수 있습니다.
@package 태그는 @access package와 동일합니다.
예
다음 예에서 인스턴스 멤버 Thingy#_bar는 생성된 문서에 나타나지만, 패키지 비공개임을 지정하는 주석이 표시됩니다.
/** @constructor */
function Thingy() {
/** @package */
this._bar = 1;
}