2013-05-07 3 views
0

@property를 비공개로 설정할 수있는 방법이 있습니까? 내가@property를 비공개로 설정

jsdoc3을 사용하고

/** 
* 
* @property {Object} shouldBePrivate but how? 
* 
*/ 
... 

은 내 문서를 두 번, 나열된 개인 특성이없는 나열된 개인 특성을 가진 다른 하나를 생성 할 수 있어야합니다.

+0

jsdoc3과 관련하여 속성을 비공개로 표시 하시겠습니까? 속성은 정확하게 사적 일 수 없으므로 "사적"이 의미하는 것을 설명하십시오. – Ian

+1

http://usejsdoc.org/tags-private.html? – lifetimes

+0

비공개 - 어떤 점에서? 그래서 속성은 jsdoc에 의해 무시됩니까? –

답변

1

JSDoc에서 @private 태그를 사용하십시오. HTML 생성기에는 비공개 멤버를 포함 시키거나 포함하지 않을 수있는 옵션이 있으므로 문서를 한 번만 생성하고 한 번만 생성 할 수 있습니다. 이처럼

:

/** 
* Lore Ipsum and stuff 
* @property {foo} 
* @private 
*/ 
+0

변수, 메소드, 모듈 및 네임 스페이스에서만 속성에서 작동하지 않는다. 내 전체 모듈을 비공개로 만들고 싶지 않고 내부의 일부 속성 만 비우고 싶습니다. – Hoffmann

+0

그것에 관한 문서를 찾지 못했습니다. 그런데 내가 작업 한 마지막 코드베이스가 태그를 사용하지 않았으므로 나는 알지 못한다. 답안의 해결책이 작동하지 않아 유감스럽게 생각합니다. 지금은 대답을 찾는데 호기심이 생깁니다. – Renan

+0

그래, 내가 지금 할 방법이 없다고 생각하기 시작했다. – Hoffmann

0

그냥 @private 태그는 개인, 또는 의미하지 기호를 표시하는 Jsdoc3 documentation

에서 태그 @private

/** 
* 
* @property {Object} shouldBePrivate but how? 
* @private 
*/ 

를 추가 일반 사용. JSDoc을 -p 또는 --private 스위치와 함께 실행하지 않으면 전용 멤버가 생성 된 출력에 표시되지 않습니다.

그래서, 단지 그들을 제외하는 옵션없이 개인 file.js의 문서에 기호 및 jsdoc을 포함

jsdoc --private file.js 

또는

jsdoc -p file.js 

를 실행합니다.

관련 문제