良いコード・悪いコードの書き方【PHP】php2023.05.28エンジニア歴2年目を迎え、ソースレビューをするようになってきて、良いコード・悪いコードって往々にしあるなと実感。4月から新卒エンジニアになった人の中には、先輩のコードはきれいなのに、自分のはなんか汚いでも、なんでかを言語化できない人って多い思う。書くけど理解が難しそうなところにだけ書く派まとめ概要この記事では、良いコードと悪いコードを見比べてなぜ悪いのか、どこが悪いのかを自分の実体験を交えながら説明出来たらなと思います。そもそも、会社でプログラムを書く以上はチーム戦です。複数人で開発をするので、自分一人だけ読めるコードはもってのほか。会社ごとにルールは違えど、コーディング規約(ルール)が存在しています。上記でも挙げたコーディング規約を守ってたら何してもいいんじゃないと感じる人はいるかも(管理人も1年前は同じ風に考えてました笑)知れません。規約を守って尚且つ良いコードにすることでかなりのメリットを受けられます生産性を上げれて、メンテナンス工数を減らせれるバグの温床を事前につぶせるほかの人が読んでも読みやすいなどです。これらのメリットを受けられるとかなり効率的な仕事ができます。意識して良いコードを書いてほしいです。良いコードってそんなに難しいものでもないと思っています。チェック機能}どうでしょうか、こういう命名をしていた人って結構多いと思います。命名をするときに気を付けてほしいのですが、そのコードを見ただけで何が入っているのか、どうな機能になっているのかが分かることが重要です。Idだけでも大丈夫ですが、何の情報かを表現することを忘れたらダメです。この行を見るだけで、何のどの情報が入っているかわかるようになります。1つの関数やクラスで数百~数千行に及ぶソースも存在します。(見るのも嫌になるけど)そんなときに、変数名だけ読めば何が入っているのか分かるのが重要です。チェック機能}関数名も変数と同じです。どんな処理をするのかを表現することです。これも数百行に及ぶコードの中で、呼び出されてもすぐにどんな処理なのかを理解できる関数名にすることが重要です。書くけど理解が難しそうなところにだけ書く派この3派閥であなたはどれでしょうか。そもそも書かない派これは、本当になしです。概要でも話しましたが、会社での開発はチーム戦です。ほかの人のことも考えてほしいです。10年くらいエンジニアしている人の中にも書かない人が居てビビりました。「???」となりました。)1行1行すべてにコメントを書く派これは、新人や何も考えていない人にありがちです。1行1行あると、本当に必要なコメントが見にくくなります。1;書きたくなることは、わからんでもないけど、コメントの意味を少し考えてほしい。コメント=人が見て分かりやすくするコメント≠何をやっているのか遂次書く悪くないし、心がけは大変良い。次のステップへ行ってほしい!!書くけど理解が難しそうなところにだけ書く派この派閥が一番いい。上記でも書いた通り、コメントは、人が見て分かりやすくすることだから、1行1行書いていたら、本当にコードで分かってほしいところが分からない。それって、コード上の重要なところを示せていないことになります。2;}これだけでいいんです。重要なところだと思うところだけ、コメントを書くことで、ほかの人が分かりやすくなります!まとめいかがだったでしょうか。命名やコメントなど当たり前のように思ってもできてない人結構います。これらって結局ほかの人(いつか見返す自分も含めて)が読みやすくなるために心がけることなんですね。人が見て分かりやすいコードを書くって心がけるだけでかなり良いコードになります。自動水やり機マイコンを使って簡単に自動水やり機を作ってみました。人でも簡単に作れると思います!データベース【PostgreSQL】Insert時のシーケンス重複エラーでつまづいた。原因は、手動でのid指定だった?開発中のエラーは速攻で対応しなくては。データベース【PosgreSQL】相関サブクエリについて。この前、新人の後輩君に「このSQLがイメージつかない」といわれ、教えたのでその際の備忘録です。相関サブクエリとは相関サブクエリは、通常のサブクエリと違い、「外部クエリへの参照が含まれている」クエリです。オブジェクト指向でJavaScriptを書くのも結構楽しい。コメントをキャンセルメールアドレスが公開されることはありません。※サイト次回のコメントで使用するためブラウザーに自分の名前、メールアドレス、サイトを保存する。管理人:K広島県でWEB系のエンジニアをしている社会人3年目の管理人:Kです。プログラミング、マイコン、働き方、家庭菜園について発信してます。【PosgreSQL】相関サブクエリについて。【PostgreSQL】Insert時のシーケンス重複エラーでつまづいた。エンジニアの部屋.メニューホーム検索トップサイドバ。