リファクタリング プログラミング

メソッドを切り出すメリット。リーダブルなコードで行こう!

投稿日:

概要

大きなクラス、長いメソッドを書いたり読んだりしていて、ロジックが追えなくなってきています。
私の周りではすごく理解が良く、長い処理でも追っていける人がいますが私はそうではありません。

私はごくごく短いロジック、意図が明確な名称でないとちゃんと頭に入りません。
読み返してももう一回理解し直さなくてはならなかったりとかで、結構つらいものがあります。

そんな私が自分自身に対して、もっと短くて、もっとわかり易くて、もっと美しいコードを書きたいという思いと、周りの人にもそのようにしてほしい(自己都合)という願いで執筆しました。
 

実装例

リーダブルでないコード

Q. さて、このコードは何を行っているでしょうか?

A. エラーがある場合は全てを表示する。

簡単なコードなので見てすぐわかる人にはわかると思いますが、
見にくく(醜く)ないですか?

私は見にくいです。
それに、視覚的に頭に入ってきません。
これをリーダブルに変えます。
 

リーダブルなコード

 
<改善ポイント>

  • 各変数で正確な意味が表現されている。
  • ロジックがメソッド名で明確に表現されている。
  • ifのネストが無くなり、判定ロジックが独立するようになった。(メンテナンスしやすい!)
  • エラーを追加する列の位置を合わせたので、見やすくなっている。

 
実際、現場で自分またはレビュー対象のコードをリーダブルにしようと思ったら、これくらいの単位から行うものなんじゃないかと思う。

リーダブルであることは「文化」なので、読みにくいコードを書いているプロジェクトや会社ではそもそもリーダブルにしようとすることを多くの人が諦めているだろうと思っています。

でも諦めないでほしい!
まずは自分から、ちょっとでも読みやすいコードを書こう!
ソースコードだけじゃなく、設計書もリーダブルにしていこう!
理解しやすいとコミュニケーションロスがなくなって、仕様が明確になって、手戻りが減る!
良いこと尽くめ!!

私も今のプロジェクトで悪戦苦闘しながら、少しでもリーダブルになる努力を続けています。
 

まとめ

  • 変数やメソッド名で意図を明確に表現するとわかり易い。
  • 列を揃えると、思いのほか読みやすい!
  • ifをネストしないのは読みやすさの定番。
  • 自分の状況がどうであれ、リーダブルに行こう!

 
最後までお読み頂き、ありがとうございました!
ご意見・ご要望がありましたら、遠慮なくコメント下さい!
もし内容が良かったらランキング評価を頂けると励みになります(^^)

ランキング評価する

-リファクタリング, プログラミング
-,

執筆者:


comment

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

CAPTCHA


関連記事

no image

【PHP】配列と連想配列と多次元配列の説明と使用例

配列とは? 1つの変数に複数の値を持つものです。 整数型や文字列型は1つの変数に1つの値を持ちますが、配列は同じようなデータの集まりを1つの変数に持つことができるようになっています。 配列には通常の添 …

【Java】LinkedHashSetの使い方(挿入順を保持するSet)

LinkedHashSetはHashSetのサブクラスであり、同じメソッドが実装されています。 メソッドの使い方であればHashSetと同じなので、HashSetの使い方を参照下さい。  ↓ 【Jav …

フロントエンジニアとバックエンドエンジニアのどちらになるべきか?

対象読者 ・これからWebエンジニアを目指す人 ・フロントエンジニアとバックエンドエンジニアの違いを知らない人   フロントエンジニアかバックエンドエンジニアか? ・役割から考える フロント …

【Java入門】プロジェクトの作成からHello, World!まで

概要 プログラミングの入門といえば「Hello, World!」です。 まずは最も簡単なプログラムを動かすことから始めていきましょう。   プロジェクトの作成 新規プロジェクト作成 新規で「Javaプ …

【TemplateMethodパターン】売上レポートをテキストとHTML形式で出力分けする事例

概要 デザインパターンのTemplateMethodパターンの事例です。 デザインパターンは増補改訂版 Java言語で学ぶデザインパターン入門で学ぶことができますし、Qiitaでも取り上げられています …

記事を探す

SpringFramworkの良書

■おすすめ教材
Javaの基本を学んだ人が、次のステップとして読む本(中級者向け)

※SpringはJavaのFrameworkの1つです。
変更のしやすさ、保守性の高さが特徴です。