[Python] 변수명과 함수명 짓기

[Python] 변수명과 함수명 짓기

변수명과 함수명은 코드의 가독성과 유지 보수성에 매우 중요하다.

함수가 무엇을 하는지 명확하게 설명하고, 변수명도 각각의 역할에 따라 명확하게 지어야한다.

 

좋은 변수명과 함수명을 지정하는 방법을 알아보자.

 

의미 있는 이름 선택

변수나 함수의 목적과 역할을 잘 설명하는 이름을 선택해야 한다.

다른 사람이 코드를 읽을 때 이해하기 쉽도록 이름을 지정하는 것이 중요하다.

#좋은 예
student_name = '홍길동'
total_score = 95

#나쁜 예
a = '홍길동'
b = 95

 

일관성

프로젝트 전체에서 일관된 명명 규칙을 사용한다.

변수명과 함수명이 일관되면 코드를 이해하고 유지보수 하기 쉬워진다.

#좋은 예
def calculate_total_price(item_prices):
    total_price = sum(item_prices)
    return total_price
    
#나쁜 예
def calculate_total_price(price_of_items):
    total = sum(price_of_items)
    return total

 

길이 조절

이름이 너무 짧으면 의미가 불분명 해질 수 있고, 너무 길면 코드의 가독성이 떨어질 수 있다.

적당한 길이로 변수명을 지정한다.

#좋은 예
average_temperature = 25.5

#나쁜 예
avg_temp_in_degrees_celsius = 25.5

 

명사와 동사 사용

변수명은 주로 명사를, 함수명은 주로 동사나 동사구를 사용하여

해당 변수나 함수가 무엇을 하는지 나타내는 것이 좋다.

#좋은 예
def calculate_total_price(item_prices):
    total_price = sum(item_prices)
    return total_price
    
#나쁜 예
def item_sum(prices):
    total = sum(prices)
    return total

 

올바른 대소문자 사용

보통 변수와 함수명은 소문자로 시작하고, 여러 단어로 이루어진 경우에는

단어 사이에 언더스코어(_)나 카멜 케이스(camelCase)를 사용한다.

#좋은 예
student_name = '홍길동'
studentName = '홍길동'

#나쁜 예
StudentName = '홍길동'

 

변수명에 타입을 명시

변수명에 타입을 명시하는 것은 코드의 가독성을 높일 수 있다.

특히 동적 타입 언어인 파이썬에서는 변수명만으로는 어떤 타입을 가지는지 명확히 알기 어렵기 때문에,

변수명에 타입을 명시함으로써 코드를 이해하는데 도움을 줄 수 있다. 

 

변수명에 타입을 명시하는 방법엔 2가지가 있다.

 

1. 접두어 사용

변수명의 앞에 해당 변수의 타입을 나타내는 접두어를 붙인다. 

str_student_name = '홍길동'
int_total_score = 100

 

2. 타입 표시 주석 (Type Hinting)

파이썬 3.5부터 도입된 기능으로, 변수나 함수의 매개변수, 반환값 등에 대한 타입을 주석으로 명시할 수 있다.

from typing import List

def calculate_total_price(item_prices: List[float]) -> float:
    total_price: float = sum(item_prices)
    return total_price

 

추가적으로 변수나 함수에 특수 문자나 숫자를 과도하게 사용하는 것은 피해야 하며, 

또한 예약어를 변수명이나 함수명으로 사용하는 것도 피해야 한다. 

이는 코드의 가독성을 떨어트릴 수 있고, 해당 함수나 키워드의 기능과 충돌할 수 있다. 

 

이러한 규칙을 준수하여 변수명을 지정하면, 코드의 가독성과 유지보수성을 향상 시킬 수 있다.