일관된 네이밍 규칙은 프로그래밍에서 매우 중요합니다. 명확하고 일관된 네이밍 규칙을 사용하면 코드의 가독성을 향상시키고 유지 보수를 쉽게 할 수 있습니다. 이번 포스트에서는 JavaScript에서의 일관된 네이밍 규칙에 대해 알아보겠습니다.
1. 변수와 상수
1.1 소문자와 대문자
변수와 상수는 소문자로 시작하며, 여러 단어로 이뤄진 경우에는 카멜 케이스(Camel Case)를 사용합니다. 카멜 케이스는 각 단어의 첫 글자를 대문자로 표기하고 단어 사이에는 공백이나 특수 문자 대신 대문자를 사용합니다.
let userName = 'John';
const maxItemCount = 10;
1.2 변수의 유형
변수의 유형을 표시하기 위해 헝가리안 표기법(Hungarian Notation)을 사용할 수 있습니다. 헝가리안 표기법은 변수 이름 앞에 변수의 유형을 나타내는 접두사를 붙이는 것을 의미합니다.
let strMessage = 'Hello'; // 문자열 변수
let numCount = 5; // 숫자 변수
2. 함수
2.1 동사와 명사
함수는 동사와 명사의 조합으로 작성하며, 여러 단어로 이뤄진 경우에는 카멜 케이스를 사용합니다.
function calculateSum(a, b) {
return a + b;
}
function getUserInfo(userId) {
// 사용자 정보를 가져오는 로직
}
2.2 함수명의 동사
함수명의 동사는 주로 동작을 나타내는 동사를 사용하는 것이 좋습니다. 예를 들어, calculate
, get
, set
, validate
등이 될 수 있습니다.
3. 클래스
3.1 클래스명
클래스명은 대문자로 시작하며, 여러 단어로 이뤄진 경우에는 카멜 케이스를 사용합니다.
class MyClass {
// 클래스의 멤버와 메서드
}
3.2 메서드명
메서드명은 변수와 마찬가지로 소문자로 시작하며, 여러 단어로 이뤄진 경우에는 카멜 케이스를 사용합니다.
class MyClass {
myMethod() {
// 메서드의 로직
}
}
4. 상수
상수는 대문자와 언더스코어를 함께 사용하여 작성합니다.
const MAX_ITEM_COUNT = 100;
const PI = 3.14;
5. 주석
주석은 코드의 가독성을 높이는데 도움을 줍니다. 주석은 소스 코드에서 특정 부분의 동작이나 의도를 설명하는데 사용됩니다. 주석은 항상 읽기 쉽고 명확하게 작성되어야 합니다.
// 사용자 이름을 변경하는 함수입니다.
function changeUserName(userId, newName) {
// 로직 구현
}
일관된 네이밍 규칙을 따르는 것은 프로그래밍의 규모가 크거나 팀 작업을 할 때 특히 중요합니다. 이를 따르면 코드를 이해하기 쉽고 유지 보수가 용이해지며, 코드의 일관성을 유지할 수 있습니다.