코드베이스를 볼 때, 변수와 함수 이름은 코드가 무엇을 하는지 이해하는 가장 빠른 방법 중 하나입니다. 암호화되거나 줄임말, 또는 너무 일반적인 이름은 개발자가 그것들을 해독하는 데 더 많은 시간을 보내게 합니다. 반대로, 신중하고 설명적인 이름은 효율적인 커뮤니케이션 및 문서화에 기여합니다. 클린 코드를 작성하기 위해 의미 있는 이름을 사용해야 하는 이유는 다음과 같습니다:
인지 부하 줄이기
우리의 두뇌는 한 번에 너무 많은 정보를 저장하기 전에 압도될 수 있습니다. 간결하거나 혼란스러운 이름은 코드가 무엇을 하는지 파싱하는 데 필요한 인지 부하를 증가시킵니다. 데이터나 작업을 명확하게 설명하는 의미 있는 이름은 개발자가 코드를 더 쉽게 이해하게 합니다.
가독성 향상
코드는 작성되는 것보다 더 오랜 시간 동안 읽힙니다. 이름에 자연어와 도메인 특정 용어를 사용하면 코드의 가독성이 향상됩니다. 예를 들어, amt보다는 orderAmount는 주석 없이 변수가 무엇을 나타내는지 알려줍니다. 과도하게 긴 이름과 짧고 불투명한 이름 사이의 균형을 찾으려고 노력하세요.
잘못된 해석 피하기
줄임말, 숫자 시퀀스 및 data나 tmp와 같은 일반적인 이름은 다른 개발자에게 다르게 해석될 수 있어 오류를 유발할 수 있습니다. 이름이 더욱 명확하고 자명할수록 잘못된 해석의 여지가 줄어듭니다.
연결 강조
관련 변수, 클래스 또는 함수를 일관되게 명명하면 그들 사이의 연결을 강조할 수 있습니다. 예를 들어, orderDate와 orderAmount와 같이 코드에서 이러한 일관된 명명 방식을 유지하면 변수간의 관계가 명확해집니다.
미래에 대비하기
변수 이름이 현재 사용되는 방식이 아니라 변수가 나타내는 내용을 설명하면 코드가 변경에 덜 취약해집니다. 예를 들어, 개발자가 변수를 calcTax라고 명명한 뒤, 나중에 판매세가 지역별로 분할되어야 한다는 것을 깨달았다면, 이름이 더 이상 적합하지 않게 됩니다. orderTax와 같은 이름을 사용하면, 의미를 유지하면서도 훗날 구현을 변경할 여지를 남겨둡니다.
키 입력이 더 많아지지만, 신중한 명명에 시간을 투자하면 유지 보수 비용과 기술 부채가 줄어듭니다. 상세한 설명이 포함된 이름은 코드에서 문서화 및 커뮤니케이션에 필수적인 역할을 합니다. 의미 있는 이름 지정 문화를 채택하고 리팩토링 중에 기존 이름을 수정하면 깔끔하고 지속 가능한 코드를 작성하는 데 큰 도움이 될 것입니다.
