skillup

技術ブログ

プログラミング全般

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

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

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

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

優れたコードの定義

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

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

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

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

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

短いコード

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

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

処理が複雑でない

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

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

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

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

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

-プログラミング全般
-

執筆者:


comment

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

関連記事

no image

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

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

no image

オブジェクト指向設計 単一責任のクラスの設計

オブジェクト指向をするうえでの大事なポイントなど Contents1 単一責任のクラス設計1.1 メモ1.2 実際のコーディング上のコツ1.3 感想1.4 参考文献 単一責任のクラス設計 メモ 単一責 …

no image

API仕様書に関する注意事項

API仕様書を作っていて、基本的な点についてのまとめ コードと連動できれば理想(現実的には設定ファイルをJSONかYamlで作るぐらいが限界だと思う) 型のチェック、必須チェック、桁数チェック、日付の …

no image

リーダブルコードまとめ

リーダブルコードほぼ読み切ったのでまとめを。チェックリスト化して、常にこれを見ながらコードは書いたほうがよさげ 前半のまとめや参考リンクでみたものとマージします。 Contents1 変数の名称2 コ …

no image

phing

今までphpunit,phpmd,phpcodesniffer,phpdocumentなどのツールをいろいろと試してきますが、個別に動かしていると大変面倒ですので、これを一気に行えるライブラリがありま …

アーカイブ