メモやプログラムの説明に使おう
こんにちは、徳です。
デジタルDIYができるようコーディング・プログラミング・画像加工・動画編集などを本やYouTubeで勉強しています。
現在は初心者なので、とにかくゆっくり進んでいくと思います。
また、「間違っていること」や「こうした方が良いよ」などがあれば、コメントなどしていただけたら幸いです。
では、いきましょう！
PHP
今回は、
コメント
を紹介させていただきます。
Webページはみんなで作るものでもあります。
そのため、他の人が書いたプログラムを見て、
これって何のことかなぁ?
とわからないことあります。
そんな時に、プログラム内にメモのように書いておけばそのプログラムの説明をつけることができます。
そんな時に使用するのが、
コメント
です。
それではよろしくお願いします。
コメント
コメントとは
コメントとは、
プログラムファイルに書いても、内容に変化のしない文
ことです。
つまり、
その文が何を意味しているかを説明する時などに使用する文
です。
用途
よく使われる用途は二つあります。
「メモ」と「一部のプログラムの一時的な無効化」です。
メモ
PHPのファイルを一人ではなく、複数人で作ることがあります。
その時一人の人が、
この文は何をしているかわからない
ということがあります。
その度に他の人に聞くのは大変です。
その時に、コメントを使用して、
ここは〇〇をする文です
などを書いて誰が見てもわかるようにしましょう。
一部のプログラムの一時的な無効化
プログラムの作成中などに、一時的に一部分を無効にして、その結果を確かめたい時があります。
その時は、その一部分をコメントで囲み無効化します。
これにより、その部分はコメント扱いとなり、プログラムへの影響をなくすことができます。
書き方
// コメント /* コメント */ /* コメント */
// は1行をコメントにするときに使用します。
/* */ は複数行をコメント文にする時に使用します。
実際、/* */は1行でも使えますので、
私は/* */を常に使用しています。
例
メモ
// 配列numに1 ~ 5を入れる $num = [1 , 2, 3 , 4 , 5]; /* 配列numの0 ~ 4まで表示する */ for($cnt=0; $cnt < 5; $cnt++){ console.log($num[$cnt]); }
このようにコメントの部分は結果に関係しません。
一部のプログラムの一時的な無効化
$num = [1 , 2, 3 , 4 , 5];
/*
for($cnt=0; $cnt < 5; $cnt++){
print($num[$cnt]);
}
*/
このようにfor文が無効化されました。
注意点
大切な情報は載せてはいけない
コメントはページ内にでは見えません。
しかし、プログラム内にはちゃんと残っています。
そのため第三者の人もみることが可能です。
なので、大切な情報は載せないようにしましょう。
まとめ
今回は、
コメント
について紹介させていただきました。
こちらは、
メモやプログラムの一部分の無効化
に使用します。
注意すべき点は、
大事な情報は載せてはいけません
ことです。
なぜなら、プログラム内にはコメントは残っているためです。
第三者の目に入るかもしれないため、それは大事な情報を載せるのはやめましょう。
最後まで読んでいただき、ありがとうございました。
コメント