【プログラミング】シンプルなコードを書くために
rnrn_toukou_iY
こんにちは。Itoop（アイティープ）の松永です。
気が付けばもう11月で、今年も残りわずかですね。年末にかけてイベントごとが多くなってきますが、今年はどこかのタイミングでゆっくり温泉につかりたいなと感じています。
さて、今回はプログラミングについてのお話です。プログラミングにおいても「わかりやすい」というのはとても大事なことです。
そんな、「わかりやすいコード」を書くときや、仕事の中で言われたことを書いていこうと思います。
わかりやすいプログラムを書く4つのポイント
「わかりやすい」というコードは感覚的なものではなく、押さえるべきポイントがある。というのは仕事の中でベテランのエンジニアの方に言われてきました。
そこで具体的に言われたことについては以下になります。
- 命名規則の遵守
- DRY原則の徹底
- 関数やクラスの単一化
- コメントを書かないコード
以上になります。上記4つのポイントは指摘としてもよく受けてきました。しかし、この指摘を受けて以降、意識してコードを書くと以前よりも読みやすくなったという実感を得られました。
「良い」と言われるものには必ず理由があるのだなと思うようにもなりました。
4つのポイントの詳細
わかりやすいコードの4つのポイントについて、具体的にどういうことかを少しお伝えします。
- 命名規則の遵守
「名は体を表す」を意識すること。変数であれば、例えばお金を表すなら「money」だったり、体重なら「weight」のように、名称を読むだけでその変数の意味が理解できるようにすること。
また、メソッド名なら「動詞 + 名詞」のようにする。例えば「お金を計算する」なら「CalculateMoney」のようにするなどです。 - DRY原則の徹底
簡単に説明すると「同じ処理は複数個所に書かない」という原則になります。
同じ処理を実行している箇所があれば、別なメソッドに切り出して共通化するといった原則になります。
同じ処理が複数個所に定義されていると整合性を保つのが難しくなるため、この原則を守ると保守性も上がる他、不要な修正を行わなくても済むという工数削減にも繋がります。 - 関数やクラスの単一化
「1つのクラスや1つのメソッドでの役割はひとつにする」ということです。例えばBMIを算出するのであればBMIだけを計算し、そのために必要な値の取得処理などは別で行うなどです。 - コメントを書かないコード
正確にはサマリーコメントと呼ばれるクラスやメソッドがどういうものかを説明するコメントを記載し、プログラム内には基本的にコメントを書かないということです。
コメントを記載する場合は「なぜそのように書く必要があるのか（Why）」の説明が必要になる場合に限り記載し、「なにをしているか（How）」については書かないというルールです。
メソッドの名前と処理を見れば基本的にコメントは必要ないくらいに、処理はシンプルにすることとを教えていただきました。
ざっとですが、以上になります。案件ごとにルールもあるかと思いますので、必ずしもすべて該当するわけではありません。
ですが、コーディングにおけるルールは公式が定義しているものもあります。私はC#を仕事で使っていたので以下はよく見ていました。
参考：https://learn.microsoft.com/ja-jp/dotnet/csharp/fundamentals/coding-style/coding-conventions
また、書籍などでも言われるものもあったり、ひとつひとつ掘り下げていけばそれこそ1つの記事として書けるくらいには奥の深いものになっています。
おすすめの書籍については以下でも過去に紹介したことがあるため、参考にしてみると良いでしょう。
【プログラミング】クリーンコードとリファクタリング
こんにちは。Itoop（アイティープ）の松永です。 この度、記事の執筆担当に任命されました。多くのエンジニアの方々にお役立ちできる記事を提供できるよう、尽力いたしま…
Itoop 
まとめ
今回もプログラミングについての考え方といったところを書いてみました。
難しい技術を使えるから良いというよりは、基本的な技術でもシンプルでわかりやすい書き方があるならそれが良いのだなと感じたのを覚えています。
また、今回挙げたものは一部で、細かいことを書いていけばもっと量が膨大になってきます。命名規則だけでも様々な記事が出てくるくらい重要視されています。
プログラミングにも慣れてきて、ランクアップさせたいという方は「シンプルさ」という観点から、今回お伝えした点を意識してみることをおすすめします。
ーーーーーーーーー
【株式会社ゆいまーる（社長：島袋尚美）】
『若者のエンパワーメントを通じて、日本を元気に』を理念に、Itoop（ITコンサルティング）、JUNGLE BREWERY（クラフトビール）、キャリア支援など複数事業を展開。
HP▷http://yuima-ru-tokyo.com/
【社長の経歴】
島袋尚美（Shimabukuro Naomi）
沖縄出身。筑波大学卒業後、システムエンジニアとして証券会社に入社。
日本IBMに転職し、ダブルワークで立ち上げの準備を開始。
28歳で独立、2016年に株式会社ゆいまーるを設立。
その後国際結婚を経て、現在は子育てをしながらママ社長として、複数の事業を手掛ける。
