読者です 読者をやめる 読者になる 読者になる

flandlescarlet's diary【情報工学生の備忘録】

元機械工学科所属だった情報工学生です。JavaScriptで適当に何かを作ったり、絵を描いていたりします。

JavaScriptに使ういろんなコメントの書き方(ゲーム)

コメントアウトの重要性

JavaScriptをWeb製作のために使用したり

またC言語の派生として、ゲームをWebで作ってみたりしたい

という事はあるだろうと思います。

自分も現在RPG製作に取り組んでいるため、より毎日ソースを見ただけで

潤滑に作業が行えるようなコメントを書くように努めています。

ゲーム製作となると、ソースは軽く1000行を超えます。

無論イベント毎に、scriptファイルを部分的に分解して呼び出すのもいいでしょう。

しかし飽くまで諸段階でのコメント記入法を考えてみました。

 

JavaScriptで使えるコメントアウト

 
//これ以降の内容は反映されない


/*

この間の内容は反映されない

*/

実質この二つである。


 <!-- これはhtmlのみに使うコメントアウトである -->

htmlのコメントアウトは飽くまで<script>タグの中身にあるソースを

JavaScript未対応のブラウザに反映させないために使用するものであり

JavaScript本体の内容をコメントアウトさせることはできない

JavaScriptにおけるコメントアウト方法の種類

【例1】

/*========================================*/
/*    マップチップ画像         */
/*========================================*/
image_dot = new Array(); image_dot[0] = "sample00.png"; //草原
image_dot[1] = "sample01.png"; //氷土
image_dot[2] = "sample02.png"; //煉瓦
image_dot[3] = "sample03.png"; //獣道
image_dot[4] = "sample04.png"; //街道
image_dot[5] = "sample05.png"; //主人公

これは、CSSで使用するコメントアウトとJavaScriptのみで使えるコメントアウトの

両方を使ったやり方である。

  • 長い区切りを説明するにはCSSコメントアウト
  • 短い単独を説明するにはJavaScriptコメントアウト

といった所であろう。

なお、【ソースが短い ≒ 簡潔で読みやすい】であるため。

この場合は配列を繰り返し分で回すのでは無く、コメントを重視して記述する方針とした。

 


 

【例2】

 switch(e.keyCode){
 /* case 37: alert("←左に行く場合"); break;
  case 38: alert("↑上に行く場合"); break;
 case 39: alert("→右に行く場合"); break;
 case 40: alert("↓下に行く場合"); break;   */
case 37://←:こっちに移動する時 walking++; //歩数計値プラス break; case 38://↑:こっちに移動する時 walking++; //歩数計値プラス break; case 39://→こっちに移動する時 walking++; //歩数計値プラス break; case 40://↓こっちに移動する時 walking++; //歩数計値プラス break;
//////////////////////////////////////////////////////////////////////////
case 17://Ctrl:説明付加 case 32: document.onkeydown = menu; break; //メニューに移動 }

onkeydownによる方向キーの制御のソースである。

その場でif文とswitch文でコメントの見やすさも変わるため、この二つの使い分けも重要となる。

  • if文は範囲条件による分岐に使用する
  • switch文は単一で働く分岐に使用する

 今回の場合は、変数が上下するものではなく、飽くまで固定で4つの変数が

恒久に何度も分岐されるため、switch文の方が簡潔でコメントが見やすくなる。

また十字キーとその他のイベントキーではまた仕様が異なるため、JavaScriptコメントアウトの

スラッシュを何度も連ねたものにして1行で区切りとしてのコメントアウトもつけた。

 

備考

このように、ゲーム製作となると各変数の量が増して関数の受け渡しも多重なものとなる。

だからこそコメントのつけ方一つ一つにより、日を跨いで作業を開始する時

潤滑に効率よく内容を把握できるため、進めることができる。

普段Web程度で短いソースしか書かない人も、試にコメントを書く習慣を身につけると

良いと思います。