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

リーダブルコードまとめ

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

no image

オブジェクト指向について その3

今回は場合分けによる変更コストとオブジェクト指向のメリットについてです。 例えば給付金が発生して、その金額を死亡時、退職時、通常時で場合分けするとき、if-elseで書けば下記のようになります。 [c …

no image

トランザクショントークンについて

フォーム画面で入力を行うときにはPOSTでデータを受け取ってエラーチェックしたり、データベースに入力をしたりします。 ただその時に何も考えずに安易に送信→受信の際に以下のようなトラブルがあり得ます。 …

no image

ミスを少なくする工夫について

プログラマであればだれもが「いかにバグを少なくするか」に腐心すると思います。 ところが、人間がある以上、バグ(ミス)は絶対にゼロにはなりません。バグ云々以前に、「人間はもともとミスをする生き物だ」とい …