プログラミング

理解しやすい良いプログラミングコードを書く技術

  1. HOME >
  2. 開発・基盤 >
  3. プログラミング >

理解しやすい良いプログラミングコードを書く技術

概要

チーム開発をするときに綺麗な良いソースコードは作成した人とは別の人が機能追加するときに今まで書かれているソースコードを理解しやすくて改修がシンプルで早くできます。

誰にでも理解しやすい良いプログラミングコードを書くにはルールや技術が必要です。その技術の説明していきます。

理解しやすい可読性の高い良いコードを書く理由

チーム開発

チーム開発では相手のプログラミングを見ることが多くあります。そして、他の人が作ったコードに対して改修をする必要が出てきます。

一昔前はプログラミングコードは動いたらOKの時代もありました。しかし、他の人から見たら何を書いているのかわかりづらく回収するのに余計な時間がかかってしまいます。

わかりづらいソースコードを防止するために本番環境に入れるとき誰かに見てもらうソースコードレビューをして、プログラミングコードの品質を保つことができます。

ソースコードレビュー

このプログラミングは今のプロジェクトに統一した書き方なのかしっかりと動くのかどうかお互いチェックします。

そのときに、理解しずらく、複雑なコードは他の人のコードレビューで修正してあげ、統一感のあるわかりやすいソースコードを保持することができます。

機能改修

一人プロジェクトでも自分で何を書いたソースコードがわからなくなる。そうなると機能追加の時に時間がかかるのでわかりやすく書く必要があります。

良いコードを書く技術

良いコードを書く技術は生まれ持ったものではなく努力によって鍛えてできる技術なのです。可動性の高い読みやすいソースコードを目指してください。

理解しやすいコードを書くことについて「リーダブルコード」というオススメの本があります。

プログラミングするとき意識する重要なことが書かれており読むたびに理解が深まります。プログラミング言語の本は古いと価値が無くなりますがこの本は何年経っても価値の高い本です。

理解しやすいコードを書くために覚えておくポイント

コードを書くときに注意していることは大まかに以下の通りです。

理解しやすいコードの定義

  • 変数名はわかりやすく・変数のスコープを縮める
  • コードをネストさせすぎない
  • 不要な機能は全て削除
  • 同じ機能をなんども書かない
  • コメントはわかりやすく

変数名はわかりやすく・変数のスコープを縮める

変数名はわかりやすく書くことがいいです。なぜならコメントを書かなくても何の変数名かわかるからです。あまり長すぎる変数名は問題ですが多少の長さは問題ないと思います。 20文字までには納めたいです。

あと変数のスコープを縮めることについてですが何でもグローバル変数にすることと変数の管理が難しく、同じ名前の変数名をつけると何がどう動くのか管理できなくなります。

コードをネストさせすぎない

If文の中にfor文さらにその中にif文を入れる等深くすると何が何だかわからないコードができてしまいます。ネストしすぎるのであれば、別の関数にするとか対応をする必要があります。

不要な機能は全て削除(YAGNI)

プログラミングをしている最中に不要なコードはできることはあります。
そのコードをもったいないからと思ってコメントにして
残している人もいるのですが、返って理解が困難なものになります。
他の人が見たら今後使うのかどうか判断できなくなるので邪魔なコードです。

同じ機能をなんども書かない(DRY)

似たコードを書くことがあります。その際は手間でも関数にまとめて繰り返し使うことをお勧めします。
同じ機能を何度も書くと大規模なコードであればあるほど複雑化します。

コメントはわかりやすく

ブログ作成者の私もたまにやりますが、コメントの内容が不明で自分で見返してもわからないということがあります。
簡潔にわかりやすくすることを心がけましょう。
私が何度も読んだ良書であるリーダブルコードはさらに詳しく載っていますので読んでみるのもいいかもしれないです。

わかりやすいコードを書く技術のおすすめ本

本の紹介を下部にしています。これらも上記のリーダブルコードと同様、良書になります。参考までにレビューしてます。

徹底的に可読性、保守性の高いプログラミングを体系的取り組みことができます。厳しいコードレビュー環境に置きたい人はこの本を読んでコードを研究してください。

プリンシプル オブ プログラミングはどのようにプログラミングを書くかよりも、いかに周りとコミュケーションをとるためにどのような思想で書くかということが書かれています。

システム開発外注先とコミュニケーションをとるときに大切なことプロジェクト管理に役立つ考え方やプログラミングを人に教えるためのことが1冊でまとめられています。

また、独学でプログラミングを覚えた、現場実践でのルールが教われない教えてもらえないという方は、参考して良いと思います。

コードコンプリートはコーディングに入る前の準備から、心構え、周囲の人との調整まで幅広い観点で書かれています。プログラミングだけでなく、設計とコーディングを兼務するSEにはかなり重要な本となるでしょう。

まとめ

上記理解しやすいコードの定義を気をつけて実践していくと良いコードになり可読性が高くなり、君のコード読みやすいねと言われることが出てきます。

良いコードを書くように日々努力を続けてください。

プログラミング
プログラマーの現状と今後の傾向

プログラマーが今どのように仕事をしているのかということと今後のプログラミングはどのような傾向があるのかわかりやすく紹介していきます。

続きを見る

-プログラミング

© 2020 スリーネクスト