2019-06-22 18:09:00

【プログラミング】すぐに実践できる良いコード【個人的な考え】

目次

1. 対象者
2. 良いコードを書く目的
3. 良いコードとは何か
4. 良いコードの実践方法
5. あとがき
6. 参考文献

対象者

「良いコード」について今まで特に意識してなかったプログラマーを対象としています。

良いコードを書く目的

私が考える良いコードを書く目的は以下の１点です。

• 処理を理解する際の負荷を軽減するため

以上です。１点と記載しましたが、いろいろと意味を込めています。

• 他の開発者からの信頼を得られるかもしれない
• 機能の改修が容易になる
• 自分が読み返したときに自分に憤らなくて済む
• 他人に読まれたときに嫌がられるのを防げる
• バグ修正が容易になる

良いコードとは何か

私が考える良いコードは以下の２点です。

• 妥当な名前が変数やメソッドにつけられていること
• 妥当なコメントがつけられていること

良いコードの実践方法

以下は関数・メソッド名を前提としています。変数名に関しても大体同じです。愛情を持って名前をつけましょう。

• 妥当な名前をつける方法

基本的に英語で考えます。

1. 処理に必要な要素をキャラクターのように考えます。

2. キャラクターの英語名を決めます。これが主語になります。

3. キャラクターが処理を行う場合の動詞を英語で考えます。

4. 主語＋動詞を構成します。

5. 必要なら目的語や補語を組み合わせます。

   以上です。

• 妥当なコメントをつける方法

基本的に「関数・メソッド名から離れた処理に対してつっこまれそうな部分」についてコメントします。例えば、「イレギュラーな処理をここで書いた理由」や「普通に考えたら別で処理するべきなのでは？に対する理由」のような部分です。理由が記載されていれば、人間のストレスが軽減するからです。

あとがき

本音を言いますと「デザインパターン」や「〇〇駆動設計・開発」、「SQLチューニング」などの知識を取り入れて・使いこなして・プロダクトに最大限活かせたほうが良いと勝手に思っています。収益は度外視していますが。

「デザインパターン」などと比べると、ここで記載した内容はすぐに実践できるかと思います。今まで意識してなかった人はぜひ試してみてください。

「リーダブルコード」にはさらに詳しく書いてありますので、ぜひ読んでみてください。

参考文献

• 「リーダブルコード」