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

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

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

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

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

実際に自分が経験した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でプログラミングの学習サポート始めました


現場で働けるエンジニア育成プラン

未経験からエンジニアに転職したいと考えている人を対象にレッスンを行っております。


私は29歳未経験からエンジニアに転職しました。

それまではミュージシャンを目指して音楽活動ばかり。
社会人としての経験はゼロでした。

エンジニア転職を決めたきっかけは、
その当時、ミュージシャンという職に対して将来的に希望がもてず、お金もなく、副業でやっていた物販にも失敗し、借金も1000万オーバー。
まさに人生のどん底で、そんなときに次の人生のステージとしてプログラミングという世界を選択しました。

あれから、数年。
今ではフリーランスとして仕事ができており、
収入もあの頃の数倍にまでなり、借金も返済できました。
エンジニア転職で人生が変わったといっても過言ではありません。

ただ、エンジニアに転職してからの時期は、困難の連続でした。
とくに最初の1−2年は、わからないことだらけで、本当にハゲるかと思うくらい苦しく、
実際に1年半後には適応障害になり、体を壊してしまいました。

プログラマーという職はタフな仕事です。

これからエンジニアを目指される方には、少しでも現場で苦労してほしくないという気持ちで、プログラミングのレッスンをしております。

私のレッスンではPHPを基本的なところからしっかりと学習していただいております。

これからPHPを使ってバックエンドエンジニアになりたい方には、大変おすすめのレッスン内容になっております。

レッスンはマンツーマン形式を採用しており、
しっかりとメンティーさんお一人お一人に対して、丁寧にコードレビューをして、
プログラミングの基礎をしっかりと身につけていただきます。
出題する問題には回答は用意しておらず、ご自身がしっかりとロジックを考えることを最大限重視しています。
また現場基準でコードレビューをしっかりおこなっておりますので、悪いクセがつくことを防ぎます。

PHPを基礎からしっかりと学習したい、Webエンジニアとして転職を考えているということでしたら、私のレッスンはおすすめできます。

実際の実績としても、
30代での転職成功者も多数!
未経験から機械学習エンジニアに転職成功!
MENTAでは圧倒的に高評価のレビューをいただいております。

エンジニアに転職して、人生を変えたい
再チャレンジしたい
と思っている方
もしかするとお力になれるかもしれません。

まずはお気軽にご相談ください。