プログラムを書く際に、後から見直しても分かりやすいコードを書くことは非常に重要です。特に他の人と共同でプロジェクトを進める場合や、時間が経った後に自分でコードを再び見る場合に大事になってきます。ここでは、後から分かりやすいプログラムを書くためのいくつかのコツを紹介します。
1. コードの可読性を高める
意味のある変数名と関数名
変数名や関数名には、その役割や内容が分かるような名前を付けましょう。例えば、`a`や`b`ではなく、`userName`や`calculateTotal`のように具体的な名前を使います。このようにすることによりその関数の意味を一目でわかるようになります。
# 悪い例
def func(a, b):
return a + b
# 良い例
def add_numbers(number1, number2):
return number1 + number2インデントとスペース
コードのインデントを統一し、読みやすくするために適切にスペースを使いましょう。Pythonでは特にインデントが重要で、コードの構造を明確にするために4スペースがおすすめです。
# 悪い例
if (x>5){
print("x is greater than 5")
}
# 良い例
if x > 5:
print("x is greater than 5")特にVisual Stadio Code の場合はindent-rainbowを使うのがおすすめです。インデントの色付けしてくれるため、間違って作ってしまったインデントが減ります。
https://marketplace.visualstudio.com/items?itemName=oderwat.indent-rainbow
2. コメントを適切に使う
コードの意図を説明する
コードの意図や複雑な部分にはコメントを追加して、他の人が理解しやすくなるようにしましょう。特に、関数やクラスの冒頭にその役割や使い方を説明するコメントを入れると良いです。
# 悪い例
def add(a, b):
return a + b
# 良い例
def add(number1, number2):
"""
二つの数値を足し合わせて、その結果を返す関数
:param number1: 足し合わせる最初の数値
:param number2: 足し合わせる二番目の数値
:return: number1 と number2 の合計
"""
return number1 + number23. 関数やクラスを小さく保つ
シングル・レスポンシビリティ・プリンシプル
各関数やクラスは一つの役割に専念し、複数の役割を持たせないようにしましょう。これにより、コードの再利用性が高まり、バグが発生しにくくなります。
# 悪い例
def process_data(data):
# データのフィルタリング
filtered_data = [d for d in data if d > 10]
# データのソート
filtered_data.sort()
return filtered_data
# 良い例
def filter_data(data):
return [d for d in data if d > 10]
def sort_data(data):
return sorted(data)
def process_data(data):
filtered_data = filter_data(data)
sorted_data = sort_data(filtered_data)
return sorted_data4. コードの再利用性を高める
DRY原則（Don’t Repeat Yourself）
同じコードを繰り返し書くのではなく、関数やクラスを使ってコードを再利用しましょう。これにより、コードの修正が容易になり、エラーのリスクが減ります。
# 悪い例
total_price1 = item_price1 * quantity1
total_price2 = item_price2 * quantity2
# 良い例
def calculate_total_price(item_price, quantity):
return item_price * quantity
total_price1 = calculate_total_price(item_price1, quantity1)
total_price2 = calculate_total_price(item_price2, quantity2)これらのコツを実践することで、後から見ても分かりやすくコードを書くことができるようになります。プログラミングの初心者でも、これらの原則を守ることで、間違えの発見しやすいコードの作成をすることができます。
コメントを残す