[javascript] 리팩토링 변수 네이밍 규칙

리팩토링은 코드를 변경하지 않고 가독성 및 유지보수성을 향상시키기 위한 프로세스입니다. 변수 네이밍은 리팩토링 과정에서 매우 중요한 부분입니다. 변수의 이름이 명확하고 일관성 있게 지어져야 코드 이해도가 높아지고 버그 발생 가능성이 줄어듭니다. 이번 포스트에서는 자바스크립트에서의 변수 네이밍 규칙에 대해 알아보겠습니다.

1. 명확하고 직관적인 이름 사용하기

변수의 이름은 해당 변수가 의미하는 바를 명확하고 직관적으로 나타내야 합니다. 불필요한 약어나 줄임말을 사용하지 않고, 해당 변수가 어떤 값을 담고 있는지 쉽게 이해할 수 있도록 지어야 합니다. 예를 들어, count와 같은 변수 이름은 명확하게 변수가 몇 개의 값을 담고 있는지를 나타내는 것이 좋습니다.

2. 일관성 있는 네이밍 스타일 사용하기

변수 네이밍 스타일은 일관성을 유지해야 합니다. 보통 자바스크립트에서는 카멜 케이스를 사용합니다. 즉, 첫 번째 단어는 소문자로 시작하고, 그 이후의 단어 첫 글자는 대문자로 시작합니다. 예를 들어, firstName, lastName, phoneNumber와 같은 변수 이름을 사용하는 것이 일관성 있는 네이밍 스타일입니다.

3. 약어와 줄임말은 최소화하기

약어와 줄임말은 가독성을 떨어뜨리므로 최대한 피하는 것이 좋습니다. 코드를 읽는 사람이 약어나 줄임말을 이해하기 어려워지고, 변수의 의미를 파악하기 힘들어질 수 있습니다. 가능한 한 전체 단어를 사용하는 것이 좋습니다. 예를 들어, usr 대신 user와 같이 의미를 분명하게 표현하는 것이 좋습니다.

4. 변수의 역할을 나타내는 이름 사용하기

변수의 역할을 나타내는 이름을 사용하여 코드를 읽는 사람이 변수의 의미를 쉽게 파악할 수 있도록 해야 합니다. 예를 들어, totalScore와 같은 변수 이름은 변수가 전체 점수를 나타낸다는 것을 직관적으로 이해할 수 있게 합니다.

5. 변수의 범위에 따른 이름 지정하기

변수의 범위에 따라 이름을 지정하여 변수의 유효 범위를 명확하게 나타낼 수 있습니다. 전역 변수와 지역 변수는 서로 다르게 명명하는 것이 좋습니다. 예를 들어, 전역 변수는 globalVariable과 같이, 지역 변수는 localVariable과 같이 이름을 지정하는 것이 좋습니다.

6. 주석을 활용하여 의도를 설명하기

변수의 이름만으로는 모든 의도를 설명하기 어려울 때, 주석을 활용하여 변수의 역할과 의도를 설명하는 것이 좋습니다. 다른 개발자가 해당 변수의 용도를 파악하기 쉽게 하기 위해 명시적인 주석을 작성하는 것이 좋습니다.

결론

좋은 변수 네이밍은 코드의 가독성과 이해도를 높이는 중요한 요소입니다. 변수의 이름을 명확하고 직관적으로 지으면 코드를 이해하기 쉬워지고 버그를 줄일 수 있습니다. 변수 네이밍 규칙을 잘 따라서 의미 있는 이름을 사용하는 것이 좋습니다. 이렇게 함으로써 유지보수성을 향상시킬 수 있습니다.

출처: 리팩토링 변수 네이밍 규칙 블로그 포스트