JsDoc Toolkitを使う！
@private
最終更新：
aias-jsdoctoolkit
トップページ > ドックコメントの書き方 > タグリファレンス >
@private
@privateタグは、この項目が他のオブジェクトから参照できないprivateなメンバであることを示します。
構文
@private
例
function Foo() {
function inner() {
}
this.notPrivate = function() {
}
}
上の例は、"private"属性がより下位のメンバに伝播しないことを表しています。このケースでは Foo クラスはprivateですが、 notPrivate メンバはそうではありません。また、メンバ inner は内部関数であることから、自動的にprivateとなります。
注意：デフォルトでは、@privateタグの付いた項目はドキュメントに出力されません。 -p コマンドラインオプションを使用すると、privateなシンボルをドキュメントに表示することができます。
ドックコメントが一切付けられていない項目もまた、デフォルトではドキュメントに出力されません。上の例では inner と notPrivate は -a または -A コマンドラインオプションが無ければドキュメントには含まれません。
関連項目
- @publicタグにより、内部関数をprivateでないかのようにドキュメントに出力することができます。
/**
* @private
* @constructor
*/