Facebook Twitter Google Maps RSS
Home 開発全般 このコメントいる?いらない?
formats

このコメントいる?いらない?

Published on 2013年9月5日, by in 開発全般.

こんにちは。
あっという間に9月になっていますね。

今日はプログラムのコメントにの書き方についてです。

処理の中に書くコメントは、作成者以外の人が確認の際の手掛かりにもなります。
もちろん作成者にとっても後から見返した際に参考になります。
意味のあるコメント、意味の無いコメントとあるのでその具体例を見てみます。

Javaで簡単に書いてみます。

パターン①—————————————
// 商品1の価格
int goods1 = 1000;
// 商品2の価格
int goods2 = 1500;
// 商品3の価格
int goods3 = 2000;
// 合計した価格
int total = goods1 + goods2 + goods3;
————————————————-

パターン②—————————————
int goods1 = 1000; // 商品1
int goods2 = 1500; // 商品2
int goods3 = 2000; // 商品3
// 合計
int total = goods1 + goods2 + goods3;
————————————————-

パターン③—————————————
int goods1 = 1000;
int goods2 = 1500;
int goods3 = 2000;
// 合計 = 商品1 + 商品2 + 商品3
int total = goods1 + goods2 + goods3;
————————————————-

処理自体は簡単なものなので③で十分かと思います。
何をしたいのかも伝わります。

②のように右に書くことでスッキリ見ることができます。

①は行数も多くなってしまいますし、1行1行だらだら書くと手間もかかりますし意味の無いコメントが
多くなります。

作業を行うプロジェクトのコーディング規約を把握してと言う前提ではありますが、コメントはどんな
処理を表現しているのかを教えてくれる手掛かりになるので、レビューする方にも気を付けて見て
もらいたいです。

また、日本語で説明する力が必要となりますが、色々なプログラムを見たり組んだりしていれば自然と
慣れてくると思います。

最後にこれだけは勘弁と言うコメントをご紹介。

おまけ——————————————-
int goods1 = 1000;
int goods2 = 1500;
int goods3 = 2000;
// 合計 = 商品1 + 商品2 + 商品3
// たぶんこれであっているはず。。。
int total = goods1 + goods2 + goods3;
————————————————-

作った人が分からないようなコメントを書いてしまうと、その他の人が分かるわけありません。
気を付けましょう。

ではまた~。

Webサイト開発実績はこちら

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です


*