javascript - @property を非公開にする

Question

@property を非公開にする方法はありますか?

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

私はjsdoc3を使用しています

ドキュメントを 2 回生成できるようにしたいと考えています。1 つはプライベート プロパティがリストされ、もう 1 つはプライベート プロパティがリストされていません。

Answer 1

@privateタグを JSDoc で使用します。HTML ジェネレーターには、プライベート メンバーを含めるか含めないかを選択できるオプションがあるため、ドキュメントを生成する場合は、1 回で、1 回で非公開にすることができます。

このような：

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

Answer 2

タグ @private を追加するだけです

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

Jsdoc3のドキュメントから

@private タグは、シンボルを非公開、または一般的な使用を意図していないものとしてマークします。-p または --private スイッチを指定して JSDoc を実行しない限り、プライベート メンバーは生成された出力に表示されません。

だから、ただ走る

jsdoc --private file.js

また

jsdoc -p file.js

file.js のドキュメントにプライベート シンボルを含め、それらを除外するオプションなしで jsdoc を含めます。