こんにちは。
本日はプログラミング初心者の方に向けて、コーディングの際のコメントで気を付けていること、
便利なショートカットキーをご紹介します。
目次
1.コメントとは
2.コメントを書くときの注意点
3.ショートカットキーでコメントアウトする
4.最後に
1. コメントとは
コメントとは、プログラミングの際にソースコードに記載される文章ですが、プログラムとして実行される命令文ではなく、プログラムの開発を行う人のために周辺のコードの意味を説明するための文章、注釈文のことです。この部分はプログラムが処理を行うときにはないものとされるため、自由に文を挿入することができます。
基本的な文法は以下の通りです。
行頭に「//」をつける
//1行のコメント
複数行まとめてコメントアウトしたい場合は「/* */」で囲む
/*
複数行のコメント
複数行のコメント
*/
2. コメントを書くときの注意点
読み手のことを考えて書く
コメントは後から処理を見直したり、他の人がソースを読んだときにひと目で処理内容がわかるように書くことが大切です。自分だけが理解できる書きかたではなく、誰が見てもわかりやすいように書きましょう。
・そのコードを見るチームのメンバー
・コードを書いた自分自身が後からわかるように書く
など、誰に書くのかをイメージすることが重要です。
また、曖昧な表現など、読み手に疑問が残る表現は避けるべきです。
コードの説明ではなく、機能の説明をする
コメントは、そのコードでどんな機能を持たせたいのかを書きます。
要約や意図を記述することで、ソースコード内容の理解が格段に上がります。
コードの翻訳(コードを見ればわかること)は書かない
//「hensu」が「speedlink」だったら「japan」と表示する
if(hensu == "speedlink"){
echo "japan";
}
上記のようなコードを見たら分かることを日本語に直訳するコメントをしてしまうと、かえって必要な情報が分かりにくくなってしまいます。
また、コメントは端的に要約して冗長にならないようにすることも重要です。
3. ショートカットキーでコメントアウトする
コメントアウトしたい箇所がたくさんある場合、いちいち記号を入力するのは面倒です。
そんな時にはショートカット機能を使えば、選択した箇所をまとめてコメントアウトすることも可能です。
使うエディタによってショートカットキーは異なりますが、それだけでプログラミングの効率が上がります。
VSCodeの場合
Windows: Ctrl + /
Mac: Command + /
Atomの場合
Windows: Ctrl + /
Mac: Command + /
上記ショートカットキーを一度入力するとコメントアウト、もう一度押すとコメントアウトを解除できます。
4. 最後に
以上、コーディングの際のコメントで気を付けていること、便利なショートカットキーを解説しました。
プログラミング初心者の方は、適切なコメントを残すことで、後で見返したときに自分自身が助けられることも多いので、意識して行っていけたら良いと思います。
最後までお読みいただきありがとうございました。