javascriptに@privateとあるのですが何でしょうか？

Question

現在JavaScriptの書き方で気になることがあります。

仕事場でよくDocのようなもので

@privateや@publicという記述があってその下に変数名がある記述を見ます。

これは何なのでしょうか？

正確に書くと

/** 
 * @private 
 */
変数名

です。

@privateの下に書いたものはprivateな変数になり、
@publicの下に書いたものはpublicな変数になるのでしょうか？

初めて見たのでこのようにコメントを書いただけでそのような使い分けができるの不思議に思っています。

自分でも調べていて「JsDoc Toolkit」を見つけました。これでしょうか？
http://www12.atwiki.jp/aias-jsdoctoolkit/pages/40.html

もし何かわかる方がいらっしゃいましたらよろしくお願いします。知識や使い方など教えていただけると助かります。

Answer 1

これは「JSDoc」といって、IDEや一部のソースコンパイラなど、JSDocを認識するような環境では、そう認識してプログラム作成の補助に使えます。

もちろん、JavaScriptの文法上は「ただのコメント」なので、実行時に考慮はされません。

Comments

[k499778]

回答有り難うございます。
やはりJsDocなのですね！
JSDocを認識するような環境だと
@privateの下に書いたものはprivateな変数になり、
@publicの下に書いたものはpublicな変数になるという認識であっているということでしょうか？

Answer 2

@privateの下に書いたものはprivateな変数になり、

@publicの下に書いたものはpublicな変数になるのでしょうか？

コメントはあくまでもコメントですので「ここで宣言している変数はprivateですよ」とか「publicですよ」とわかりやすく書いているだけだと思います。

Comments

[k499778]

回答ありがとうございます。

やはりそうなんでしょうか。

/**
* @private
*/
変数名

/**
* @public
*/
変数名

という書き方をしていて
ほぼ同じ位置に書いているので、privateとpublicをどうやって分けているの？
と思っています。その分けているのがコメント(Doc)なのかなーと思っていたのですがちがうんですかね。

[退会済みユーザー]

class内に書かれているのだと思いますが
@publicとなっている変数には
var hoge;
.....
getHoge:function(){
return this.hoge;
}
のような感じで外側から参照できるようにgetter/setterが用意されているのだと思います。

[k499778]

返答ありがとうございます。
なるほど。
もう一度仕事場のコードを見なおして確認してみます！

Answer 3

勘違いの防止のためですが、あくまでただのコメントであって、本当にprivateになったりpublicになったりはしません。

Comments

[k499778]

回答ありがとうございます。
やはり機能的な意味はもたないのですね。
ありがとうございました。