C言語の適切なコメントの書き方

プログラミング C言語

C言語のコメントの書き方は2種類あります。

「/* */」で囲む方法と「//」で書く方法です。

元々は「/* */」で囲む方法でしたが、のちに開発された「C++」の影響を受けて「//」のコメントも許可をするようになりました。

スポンサーリンク

C言語のコメントの書き方

C言語に限らずソースコードに適切なコメントを挿入しておくことはデバッグ時や、保守・メンテナンス、機能追加時などに非常に重要になります。

C言語のソースファイルには2種類のコメントの書き方があります。

「/* */」でコメントを書く方法

C言語でコメントを挿入する際は、コメントを「/* */」で囲まれた部分に挿入します。

    printf( "ここに文字を出力する\n" ) ;    /* ここはコメントなので実行時には影響を与えない */
    printf( "複数行にわたるコメントも書けます\n" ) ;  /* ここから次のコメント終端が
                                                  出てくるまでは
                                                  ずっとコメント行です。
                                                  実行時に影響をあたえません */

このように「/* */」でコメントを囲む場合は複数行に渡ってコメントに設定できるというメリットがあります。

但し、終端の「*/」を挿入忘れをして抜けると、本来の実行ステップまでがコメントになってしまうと言う不具合を生むので注意が必要です。

「//」でコメントを書く方法

もう一つのコメントの書き方は「//」で区切る方法です。

これは「//」以降、改行文字が出てくるまでコメント行になります。

よって「//」でコメントを書く場合は複数行に渡るコメントは書けません

    printf( "ここに文字を出力する\n" ) ;    // ここはコメントなので実行時には影響を与えない
    printf( "複数行にわたるコメントも書けます\n" ) ;  //このパターンでは複数行に渡るコメントは書けない
                                                     //なので各行に「//」を入れる必要がある。

適切なコメントの書き方

さて、C言語のコメントの挿入方法はわかったので、どういうコメントが「適切なコメント」なのかですね。

よく新人プログラマーの作るコードにあるのは以下のようなコードです。

    i = 1 ;      //iに1を入れる

確かにプログラムとしては間違いではないのですが、このコメントを見ても「なんで1を入れるのか?」「iって何?」ってわからないのです。

    i = 1 ;    //ループの初期値に1(○○は1相対のため)を入れる

と書いておけばなぜ「0」ではなく「1」なのかが明確になり、ソースの修正時にも迷うことがなくなります。

このようにソースコードのコメントは後で見て「(やっている)意味がわかる」コメントを書くべきです。

まとめ

C言語のコメントの書き方には「/* */」と「//」の2種類があります。

コメントの内容も後で見て「(やっている)意味がわかる」コメントを書くようにしましょう。

以上、C言語の適切なコメントの書き方でした。

タイトルとURLをコピーしました