skillup

技術ブログ

プログラミング全般

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

投稿日:2016年6月28日 更新日:

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

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

優れたコードの定義

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

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

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

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

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

短いコード

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

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

処理が複雑でない

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

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

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

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

プログラミング中級者に読んでほしい良いコードを書くための20箇条

-プログラミング全般
-

執筆者:


comment

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

関連記事

no image

フレームワークのマイナーバージョンチェンジの影響に関して

ここ1年ぐらいPHPのフレームワークはLaravelを使っていますが、マイナーバージョンの影響に悩まされることがたまにあります。 以前、遭遇した事象としてはログイン連携が急にできなくなりました。 La …

no image

DIとDIコンテナについて再考

今までも何度かやったDI(Dependency Injection = 依存性の注入)について。 以前のリンク PHPにおけるDI スコープアノテーションとCDIについて Contents1 DIとは …

no image

PCクラッシュ時に備えて

先日、ずっとメインで使っていた会社のノートPCがクラッシュし、再起不能になりました。ファイルなんかはクラウドで管理していたものが多かったので実害はあまりなかったんですが、当然ゼロではありませんでした。 …

no image

便利すぎる道具の弊害

現在、Javaのプロジェクトでは会社でNetbeansを使っていますが、IDEを使っているばっかりに理解できていないところがありました。便利すぎる道具の弊害ですね・・・ IDEについて一応説明をしてお …

no image

マイクロサービスについて

マイクロサービスについて勉強したので少しメモを。 参考文献 Software Design 「2020年1月」 Contents1 マイクロサービスとは?1.1 具体例1.1.1 フロントエンドとバッ …