클린 코드는 여러가지 측면이 있지만, 그 중에서도 다른 사람이 쉽게 이해하고 유지보수할 수 있는 코드를 작성하는 것이 중요합니다. 이를 위해서는 가독성, 명확성, 간결성 등이 필요합니다. 아래는 클린 코드를 작성하는 예시 코드입니다.
# 좋은 변수명 사용하기
def calculate_rectangle_area(length, width):
return length * width
# 함수의 기능을 잘 나타내는 이름 사용하기
def get_unique_values(values_list):
return list(set(values_list))
# 코드 중복을 피하기
def calculate_circle_area(radius):
PI = 3.14
return PI * radius ** 2
def calculate_sphere_volume(radius):
PI = 3.14
return (4/3) * PI * radius ** 3
# 위의 중복된 코드를 함수로 분리하기
def get_pi():
return 3.14
def calculate_circle_area(radius):
return get_pi() * radius ** 2
def calculate_sphere_volume(radius):
return (4/3) * get_pi() * radius ** 3
# 적절한 주석 사용하기
def calculate_triangle_area(base, height):
"""
삼각형의 넓이를 계산하는 함수
:param base: 삼각형의 밑변
:param height: 삼각형의 높이
:return: 삼각형의 넓이
"""
return 0.5 * base * height
위 예시 코드에서는 함수의 기능을 나타내는 이름을 사용하고, 코드 중복을 제거하는 등 클린 코드를 작성하는 방법을 보여줍니다. 또한, 함수에 대한 적절한 주석을 작성하여 코드를 이해하기 쉽도록 합니다.