skillup

技術ブログ

プログラミング全般

読みやすいコードについて

投稿日:

コードリーディングにおいて聖典となっているリーダブルコードについて読んでいこうかと。

ただ読んでいくだけではつまらないので、自分なりの考え方も書いていきます。

優れたコードの定義

まずは優れたコードの定義から。

リーダブルコードでは「読みやすい、理解しやすいコード」って書いてあります。

目的としては当然、保守しやすくするためで「他人が読んでもわかる状態」にすることが大切。ちなみにこの場合の「他人」で最もあり得るのは将来の自分でしょう・・・

少し時間がたつとコードって基本わけがわからなくなるので・・・これには完全に同意。

読みやすいにもいろいろあるかとは思いますが、下記のようなことが大事。

短いコード

自分の場合、一番注意しているのはこれですね。基本的にプログラムは長ければ長いほど理解しにくくなります。なるべく処理ごとに分割して短いコードを目指しましょう。目安としては20~30行以内になるようにしています。

50行を超えるような場合、特別な理由がなければ別メソッドに切り出したほうがよいでしょう。長くしていいのはコントローラー的なメソッドか並列的な処理(switch)が続いた場合のみにしてます。

処理が複雑でない

短くても無理やり1行にしていたりとか、かえってわかりにくくなっているコードは少なくありません。

短くするのは理解しやすくするための手段なので長く書いたほうが理解やすい場合は当然長く書いたほうがよいです。

次回以降もっと具体的に書いていきます。

ちなみにコードに関して参考になった記事を下記に。

http://anopara.net/2014/04/11/%E3%83%97%E3%83%AD%E3%82%B0%E3%83%A9%E3%83%9F%E3%83%B3%E3%82%B0%E4%B8%AD%E7%B4%9A%E8%80%85%E3%81%AB%E8%AA%AD%E3%82%93%E3%81%A7%E3%81%BB%E3%81%97%E3%81%84%E8%89%AF%E3%81%84%E3%82%B3%E3%83%BC%E3%83%89/

 

-プログラミング全般
-

執筆者:


comment

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

関連記事

no image

変数の役割について

前回のエントリーの主眼は変数を置くことで、適切な情報量に分割し、コードを読みやすくしよう、ということでした。 今回はそれとは少し逆の観点でして、不要な変数を削除して、コードを読みやすくしよう、というこ …

no image

シェルの基礎+ユーザー切り替え関連

雑誌を見ていたらシェルの特集があったので、ちょっとメモリます。 補強したいところのみ要点をチェック。 Contents0.1 実行パスについて0.2 ビルドインコマンド0.3 シェル変数・環境変数0. …

no image

調査スキルについて

本日は実務でとても大切な不具合の発見方法について 通常のプログラマとして仕事をしておりますと、通常の実装よりは不具合時の調査のほうが難しいことが多々あります。 もちろんものによるんですが、経験のある人 …

no image

オブジェクト指向 ドメインモデル

本日も引き続き「現場で役立つシステム設計の原則」を読み進めてます。 本日は主にドメインモデルの考え方について。 Contents1 ドメインモデルの考え方1.1 要点1.2 感想 ドメインモデルの考え …

no image

エディタatomについて

今までのエディタですが、 gvim eclipse をメインに使ってました(PHPでは)。 エディタとか一旦なれるとなかなか変えにくいのでずっと上記のままでいこうと思ったんですが、今の現場でatomを …