プログラムにおけるコメント
コメントって聞いてどのような機能を思い浮かべるでしょうか?
プログラミングにおけるコメントとは,「コード(プログラム)上に残せる,コードの意味などをメモする機能」を意味します.
プログラムが長くなっていっても,メモをしっかり残しておくことで後から振り返っても,何をするコードだったのかを理解しやすくなります.
また,コメントになっている部分はコンパイル時に無視されますから,何を書いていても大丈夫です.
例えばエラーをふくんだコードであってもコメントにしておけばコンパイルが通る,というわけです.
ココがポイント
コメントとはメモ機能・何を書いても大丈夫
C言語におけるコメント
それでは,C言語のコメントの書き方をお伝えします.
現在エディタ上に表示されているコードをご覧ください.
//
// main.c
// C_TEST
//
// Created by xxx on 2021/09/08.
//
#include <stdio.h>
int main(int argc, const char * argv[]) {
// insert code here...
printf("Hello, World!\n");
return 0;
}
実は,このプログラムにはすでにコメントが書かれています.
そう,行の先頭が「 // 」 から始まっている行は,コメントという扱いになるんです.
これは,その行だけをコメントアウトしたい場合に使います.
ココがポイント
// の後はコメントになる
そしてコメントにはもう一つ書き方があって,「/* 〜 */」で囲んだ部分がコメントという扱いになります.
これは,複数行跨いでも効果がありますので,例えばこのように使えます.
/*
ここはコメントだよ.
何を書いてもコンピュータにはわからない.やーいやーい.
*/
ココがポイント
/* 〜 */で囲んだ部分はコメントになる
コメントは超大事
最後にコメントの重要性についてお伝えしておきます.
人間は忘れる生き物です.
たとえそれが自分が書いたコードであっても,2日たてばそれが何をするコードだったのか忘れてしまうことはよく発生します.
※マジです.
なので,それが何をするコードだったのか,毎回きちんとコメントを残しておく習慣をつけておくことをお勧めします.
特に初心者のころであれば尚更です.
今後もどんどんコードを書いていきますが,毎回コメントを書いて,そのコードの意味を振り返られるようにしておきましょう!
ココがポイント
コメントはどんどん書こう