コードを書くときにコメントはいるか、いらないかって話

コードを書くときにコメントはいるか、いらないかって話

あなたはコードを書く時に、コメントをしっかり書く派ですか?書かない派ですか?

よくプログラミング入門の本に書かれていますが、「良いコードの条件は、コメントがしっかりと書かれていること」ってきいたことないですか?

でも、じつは現場によっては、コメントがあればあるほど、「ダメなコード」と見られがちです。

実際に自分が経験した2つ目の現場では、コメントを書くことが禁止でした。

なぜコメントを書くのが禁止なの?

なぜ、コメントを書くことが禁止なのか?
その理由としては、

・コメントがあると汚い
・コメント自体が間違っている可能性がある
・そもそも、コメントを見ないと分からないようなソースは書かない

などが理由になります。
プログラミング初心者の方ほど、コメントをつけがちです。

例えば以下の例。

//名前を代入
$str = "Michael";

//あいさつ関数を呼び出し
func($a);

//あいさつ関数定義
function func($str) {
//あいさつを出力
echo "Hello, " . $str . "!" . PHP_EOL;
}

どうです?
コメントうざくないです?w

むしろ、変数名が適当すぎて、コードだけでは何を書いているのか読むのに時間がかかりませんか?
$strってなんだよと、一瞬でも考えてしまったら、それはダメなコードなのです。

本来、わかりやすいコードにはコメントなど不要なのです。

これをリファクタリングするなら、

$name = "Michael";
greet($name);
function greet($name) {
echo "Hello, " . $name . "!" . PHP_EOL;
}

これでOK。

「名前」を表す変数$name
「あいさつ」を表す関数greet()

ぱっと見た感じ、コードを詳細に見なくても一瞬で、
「ああ、あいさつしてるんだなぁ」と想像つくと思います。

これが、良いコードとされています。

ぜひ参考にしてみてくださいね^^

このような話もMENTAで行っているレッスンではお話しております〜
現場で使える情報もどんどんシェアしているので、ものすごく実践的だと思います。

しっかりと基礎からプログラミングを学びたい方は、ぜひお気軽にメッセージくださいね( ^ω^ )

MENTAでプログラミングの学習サポート始めました