JavaScriptのコメントアウト
コメントアウトとは、プログラミングのソースコードに特定の印を記載して、 その部分の処理を行わせないようにする事です。
問題が起きているコードの処理を行わないようにしたり、 開発中に試行錯誤する場合等に使います。
他に重要な用途として、処理の内容の説明の記載や変数・関数の説明文を記載するのにも使われます。
JavaScriptでのコメントアウトの書き方
1行だけコメントアウトしたい場合は、//をその行に記載します。
confirm('Hello, world! 1');
// confirm('Hello, world! 2');
confirm('Hello, world! 3');この場合、1番目と3番目のメッセージがだけが表示されるようになります。
複数行の範囲をコメントアウトしたい場合は、/**と*/でその範囲を囲みます。
/**
confirm('Hello, world! 1');
confirm('Hello, world! 2');
*/
confirm('Hello, world! 3');この場合、3番目のメッセージがだけが表示されるようになります。
開発者に役に立つコメントとJSDoc
特定の書式でコメントを記載することで、その内容を他のツールで使ったり、自動でドキュメントを作成したりできます。 使用しているエディタやIDEにもよりますが、記載した内容が自動で表示されるといったメリットもあります。
JavaScriptでよく使われるコメントのマークアップ方法としては、JSDocがあります。
以下の内容程度を書いておくと後々役に立ちます。
/**
* 項目を保持しているかを示します。
* @type {boolean}
*/
let hasItems = true;
/** @type {number} */
let staffNumber = 0;
/**
* 足し算の結果を取得する。
*
* @param {number} a 加算される値
* @param {number} b 加算する値
* @return {number} 足し算の結果
*/
function add(a, b) {
return a + b;
}