クリーンコード（Clean Code）とは
クリーンコード（Clean Code）とは、初めてそのコードを見た人であっても容易に理解・変更ができるコードです。
クリーンコードを意識することで業務の効率が上がります。
意識するポイント
具体的には、以下の点を意識するとよいでしょう。
- 適切なコメント
- 変数名・関数名
- わかりやすい構文
例えば、以下はjavascriptで書かれたコードの一部です。
この関数がどのような関数であるか、すぐにわかるでしょうか？
|
1 2 3 4 5 6 7 |
function h(v) { if (v === 3) { return true; } else { return false; } } |
一方、こちらはクリーンコードを意識した上記と同じ内容のコードです。
|
1 2 3 4 5 6 |
// Determine if the argument matches 3 function isParameterEqualsToTree(parameter) { return parameter === 3 ? true : false; } |
どちらが、理解しやすいかは一目瞭然です。
また、コメントは理解の助けになりますが、内容や量は吟味しましょう。
例) 無駄なコメントが多いコード
|
1 2 3 4 5 |
// this function returns true if the parameter of the function is a 3. It will also return a false if the parameter of the function is a number diferent than 3. function isParameterEqualsToTree(parameter) { // this is the part of the code that returns the number. return parameter === 3 ? true : false; } |
上記で説明したポイントは一例ですので、クリーンコードについて各自で調べてみましょう。
Exercise
以下は、三角形の周の長さを求めるpythonプログラムです。
実行すると、各辺の長さ 3,4,5 からなる三角形の周の長さが計算されて、12を出力します。
|
1 2 3 4 5 6 7 8 9 |
def c(a:int, b:int, c:int) -> int: perimeter = a + b + c return perimeter def main(): print(c(3, 4, 5)) if __name__ == '__main__': main() |
以下の点を考慮してコードを修正してみましょう。
- クリーンコードを意識してください。
- 将来的に、三角形以外の図形の周の長さを求める処理を追加することを想定して、コードを設計してください。
Tips
関数名について
プログラミング言語ごとに関数の命名規則があるため、使用する言語の命名規則を調べるようにしましょう。
たとえば、Pythonではsnake_caseが推奨されています。
参考：
