개발 시간을 줄여주는 이름 짓기와 주석쓰기

개발자의 글쓰기라는 책을 읽으며 기록하고 싶은 내용이 생겨 이 글을 쓰게 되었다.

이 글에서는 변수명을 잘 짓는 방법에 대해서만 정리할 예정이다. 이 책에는 변수명을 잘 짓는 방법 외에도 개발자가 네이밍을 할 때 도움을 주는 내용들이 많이 담겨있다. 변수명 짓는데 어려움을 느끼거나 주니어 개발자들이 읽어보면 좋을 것 같다.

2장 개발 시간을 줄여주는 이름 짓기와 주석 쓰기

변수명을 잘 짓는 방법

1. 가독성이 좋은 이름
2. 검색이 잘되는 이름
3. 중요한 단어를 앞에 쓰기
4. 약어의 사용을 보편성을 기준으로 정해서 사용하기
5. 복수형을 나타내는 s보다는 직관적인 listOf나 array로 작성하기

1. 가독성이 좋은 이름

날짜 변수를 설정할 때도 여러가지 방법이 있다. m, d, y와 같이 단어의 앞문자만 따서 작성할 수도 있고 month, day, year와 같이 단어를 전부 적을 수도 있다. 알파벳 한 글자는 한눈에 어떤 변수를 의미하는 것인지 알 수가 없기 때문에 단어로 작성하는 것이 좋다.
하지만 의미 없는 변수는 없다. 오늘을 의미하는 변수에는 today를 임의의 날에는 someday와 같이 의미와 의도를 담아 작성해주는 것이 좋다.

// 좋지 않은 예
let m;
let d;
let y;

// 좋은 예
let today;
let thisMonth;
let NextYear;

2. 검색이 잘되는 이름

구매한 사람, 회원가입한 사람, 특정 인증을 완료한 사람 등 사용자를 구별할 때 사용하는 변수들이 많다. 이때 단순하게 buyer, register 라고 작성해도 되지만 해당 단어들 앞에 사용자 user를 붙여 작성하면 변수를 다시 사용하기 위해 검색할 때 편리할 것 이다.

// user를 붙이지 않은 경우
let buyer;
let register;

// user를 붙인 경우
let userBuyer;
let userRegister;

3. 중요한 단어를 앞에 쓰기

중요한 단어를 앞에 써야하는 이유는 검색이 잘 되게 하기 위해서이다.

블로그에 방문한 총 방문자를 나타내는 변수를 totalVisitor로 작성하는 경우가 많다. 하지만 다시 이 변수를 사용하기 위해 검색할 때 방문자 visitor로 검색하는 사람들이 더 많을 것이다. 이 경우에는 total보다 visitor이 더 중요한 요소인 것이다. 따라 visitor를 앞에 적는 것이 더 좋다.

let totalVisitor;

let visitorTotal;

4. 약어의 사용을 보편성을 기준으로 정해서 사용하기

HTML을 Hyper Text Markup Language라고 하지 않는 것처럼 보편적으로 사용하는 약어들은 사용해도 괜찮다.

예시

• document = docs
• arguments = args
• parameter = params 줄여서 쓰자.

5. 복수형을 나타내는 s보다는 직관적인 listOf나 array로 작성하기

변수명에 복수를 나타내는 s를 붙여서 변수를 작성할 수도 있지만, 카멜케이스로 작성되기때문에 s는 눈에 잘 띄지 않는다. 따라 복수라는 것을 쉽게 알아볼 수 있도록 하고 싶다면 listOf나 array를 사용해주는 것이 좋다.

// UsersNames의 s가 눈에 잘 띄지 않는다.
checkUsersNamesUnder2Characters();

// s 대신 Array를 사용
checkUsersNameArrayUnder2Characters();

좋은 이름이 가진 5가지 특징

• easy to Search; 검색하기 쉽다.
• easy to Mix; 조합하기 쉽다.
• easy to Agree; 수긍하기 쉽다.
• easy to Remember; 기억하기 쉽다.
• easy to Type; 입력하기 쉽다.