변수 명과 함수 명의 중요성
변수 명과 함수 명은 코드의 가독성과 유지보수성에 큰 영향을 미친다. 적절한 이름을 사용하면 코드 이해도가 높아지고, 협업 시 소통이 원활해지며, 오류를 빠르게 찾아내는 데 도움이 된다.
- 가독성 향상
명확한 이름은 코드 이해를 쉽게 하여 가독성을 높인다.
예를 들어, userAge라는 변수는 사용자의 나이를 저장한다는 의미를 분명히 전달한다.
- 유지보수 용이
잘 지어진 이름은 유지보수 시 혼란을 줄여준다.
totalAmount라는 변수 이름은 총 금액을 나타내어, 나중에 코드를 수정할 때 쉽게 이해할 수 있다.
- 협업 효율성 증대
일관된 이름 사용은 팀원 간의 소통을 강화한다.
팀원이 fetchData()라는 이름을 사용하면, 다른 팀원들은 이 함수가 데이터를 가져오는 기능임을 바로 알 수 있다.
- 디버깅 시간 절약
명확한 이름은 오류를 빠르게 찾아내는 데 도움이 된다.
calculateTotalPrice()라는 함수에서 오류가 발생하면, 해당 함수의 이름만으로도 어떤 기능에서 문제가 발생했는지를 쉽게 추측할 수 있다.
- 문서화 필요성 감소
잘 지어진 이름은 코드의 의도를 명확히 드러내어 추가 주석의 필요성을 줄인다.
isLoggedIn이라는 변수는 로그인 상태를 나타내므로 별도의 설명 없이도 이해할 수 있다.
변수 및 함수 명명 표기법
변수 명이나 함수 명을 명명할 때는 몇 가지 표기법이 있다. 대표적으로 낙타 표기법과 스네이크 표기법이 있다.
- 낙타 표기법 (camelCase)
첫 글자는 소문자로 시작하고, 이후 각 단어의 첫 글자는 대문자로 표기한다.
firstName, totalAmount
- 스네이크 표기법 (snake_case)
모든 글자를 소문자로 작성하고 단어 사이를 언더스코어(_)로 구분한다.
first_name, total_amount
변수 및 함수 명명 규칙
기본 명명 규칙
- 첫 글자는 문자로 시작해야 한다.
변수 이름은 반드시 문자로 시작해야 하며, 숫자로 시작하는 1stName 변수 명은 잘못된 명명이다.
올바르게 작성하기 위해선 firstName 변수를 사용해야 한다.
- 공백을 사용하지 않아야 한다.
변수나 함수 이름에는 공백이 포함될 수 없다.
first name은 잘못된 표현이며, firstName처럼 붙여 써야 한다.
- 특수 문자를 사용해서는 안 된다.
변수 명에 $, %, @ 같은 특수 문자를 포함할 수 없다.
예를 들어, user$Name은 잘못된 예이고, userName이 올바른 이름이다.
- 예약어를 사용해서는 안 된다.
프로그래밍 언어에서 정의된 예약어는 변수나 함수 이름으로 사용할 수 없다.
class는 예약어이므로 사용할 수 없으며, 대신 userClass 같은 이름을 사용해야 한다.
- 너무 짧거나 긴 이름은 피해야 한다.
변수나 함수 이름이 너무 짧으면 의미를 파악하기 어렵고, 너무 길면 가독성이 떨어진다.
a는 짧은 이름이고, thisIsAVeryLongVariableNameThatIsHardToRead는 너무 긴 이름으로 피해야 한다.
명명 규칙의 원칙
- 이름을 통해 의도를 드러내야 한다.
변수와 함수 이름은 그 목적이나 기능을 명확히 나타내야 한다.
calculateInterest()는 이 함수가 이자를 계산함을 잘 나타낸다.
- 축약하지 않는다.
변수 이름에서 의미가 명확하지 않은 축약어는 피해야 한다.
numStudents보다 numberOfStudents가 더 명확한 표현이다.
- 일관성을 유지해야 한다.
프로젝트 내에서 같은 표기법을 유지하는 것이 중요하다.
firstName과 last_name은 서로 다른 표기법이므로 일관성이 떨어지는 잘못된 예다.
- 동사 + 명사 조합을 사용한다.
함수 이름은 기능을 명확히 나타내기 위해 동사와 명사를 조합해야 한다.
updateData(), displayInfo(), setConfiguration()처럼 일반 동사로 시작하여 작업을 분명히 해야 한다.
상태를 나타내는 변수 이름은 일반적으로 is로 시작한다. 예를 들어 isLoggedIn은 쉽게 알아볼 수 있다.