こんばんは、きちんとコメントを書くとプログラミングをするときに便利と知ったので正しくコメントも書きたい な～ です。

VSCodeで/**でEnterキーを押すをJSDOCコメントのレイアウトがでてくるので、最近はもっぱらそれを表示させてそこから編集しています。

クラスのコメント

今回、一番しっくりこなくて困り果てているのが、クラスのコメントです。

/**
* 何だか楽しくなるクラス
* @param {string} arg1 もっと面白くする引数
* @param {Array.<number>} arg2 処理される数値のリスト
* @constructor
* @extends {goog.Disposable}
*/
project.MyClass = function(arg1, arg2) {
// ...
};
goog.inherits(project.MyClass, goog.Disposable);

クラスのコメントには、@constructorという項目が必要なのと、クラスであることがあらわされるように設定しなくてはいけないようです。

また、コメントはクラスの直前にかくんですね。まだまだ、JSDOCのルールがあたまに入っていないので、たくさん調べてきちんと書けるようになりたいです。