コードをどのように構築するか。「良いコード」を書けるようになるための学習方法について

Question

お聞きしたいこと

タイトルにもございます通り、良いコードを書くためにはどのようにコードを構築すれば良いか、方法論が記述されている参考書の紹介や学習方法について皆様にお聞きしたいです。

質問の経緯

IT企業に入社し早三年、最近ようやく製造工程で手が動くようになってきました。
実装したい処理を記述するために、どのようなパーツを記述すれば良いかは思い浮かぶようになってきたのですが
コードレビュー時に構築方法について指摘されることが多いなと最近感じております。

例えば
・同じ処理を繰り返し記述しているが、メソッドを切り出して使いまわしなさい
・if文のネストが深いし読みづらい。こういう書き方をして条件分岐を減らしなさい
・変数名が長い、そしてわかりづらい。単語を厳選しなさい
etc...

自分のコードは客観的に見ると「動けば良い」という構築方法になっており
可読性が低い、効率的なコードの記述がされていないです。

最近試し始めたこと

リファクタリング系の参考書を買って読み進めている
→(リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice))

Answer 1

本件が求めている

参考書の紹介や学習方法

ではない，単なる戯言ですが…

コードを書くときには
自身の記憶力やコードを読む能力を過小評価する（とでもいえば良いか？）ようにしています．
「完全に忘れた頃に見たときに読むのに苦労しないように」という観点を持って書く，というか．

Comments

[hentaiman]

> 「完全に忘れた頃に見たときに読むのに苦労しないように」
苦労した時に感じた不満を次回作るコードに反映出来れば改善出来そうですね

Answer 2

自分のコードは客観的に見ると「動けば良い」という構築方法になっており 可読性が低い、効率的なコードの記述がされていないです。

自身のコードを見てそう思うのでしたら良い傾向です。そこからどうすれば良いかを考えること。場合により設計から見直してみるくらいの気概を持つこと、です。

1つのことを実現するための道筋は1つではありませんので、「より良い道筋」はあっても「ベスト」は基本的には存在しないものと思って良いと私は思っています。

それに、現場のコーディングガイドラインにも影響は受けます。
厳しいところは変数の付け方や宣言の場所、共通化のガイドラインまで決められていたりします。
（私は実際に「○○行以上になるようならメソッド化検討」「1行○○字以上になるようなら改行」というガイドラインがある現場に入ったことがあります）

現場には現場の方針や理念があってガイドラインがありますので、そこに沿うことを前提として、「より良いコード」が書けるように常日頃から考えていくと良いでしょう。
あとは先輩同期後輩関係なく様々なコードに触れ、様々な人の意見（レビュー）を受けることも成長に繋がります。

リーダブルコードは業界としては名著として知られていますし、経験年数関係なく非常に参考になる書籍だと思います。「基本」としてもっていて損はないでしょう。
「過去の自身のコードにどれだけツッコミを入れられるか、リファクタリングしていけるか」というのも自身の成長を試す・知る　一種のバロメータにもなると思います。