ソースコードの中に注釈を残したい場合は「コメント」を使用します。
コメントに指定された部分はプログラムで実行されないので、好きにメッセージを書く事ができます。

行コメント

行コメントは「//」とスラッシュを2つ入力します。
// から後ろの改行までの文字列がコメントになります。

//ここはコメントです。
alert("ここはコメントではありません。"); //ここからはコメントになります。
//ここからコメントです。 alert("ここもコメントになります。");

ブロックコメント

ブロックコメントは「/**/」と入力します。
/* から */までの間に挟まれた改行を含む文字列がコメントになります。

alert("ここはコメントではありません。");
/*
alert("ここはコメントです。");
alert("ここもコメントです。");
ここもコメントの範囲内なので、メッセージを書く事ができます。
*/
alert("ここはコメントではありません。");

alert("ここはコメントではありません。"); /* alert("ここはコメントです。");
ここもコメントです。
このように、行の途中からブロックコメントにする事もできます。 */

ブロックコメントは複数行に渡ってコメントにする事ができるので、プログラムの概要や見出し等に使われる事もあります。

/*
 * プログラムの名前
 * プログラムの概要
 * プログラムを書いた人の名前や、書かれた日付など
 */

 /* ========================================
    ○○の処理ここから
  ========================================== */

ここまで解説してきましたが、コメントを書く上で重要なことがあります。
コメントはあくまでソースコードを理解する上での補助の役割と言うことです。
むやみに書くのではなく、伝えたい内容を簡潔に書くことを心がけることが必要です。

This software includes the work that is distributed in the Apache License 2.0

Last modified: Monday, 23 April 2018, 3:13 pm