[개발자의 글쓰기] - 2 . 변수 작명 센스 늘리기

본 글은 "개발자의 글쓰기" 를 읽고 쓰는 회고록 입니다.

 

이글은 변수 네이밍 규칙에 이어서 진행했습니다.

[개발자의 글쓰기] - 1 . 변수 네이밍 규칙

긴이름? 짧은 이름? 검색 잘 되는 이름!

• 요즘은 IDE가 잘 되어있기 때문에 몇 단어만 입력해도 변수가 검색이 됨. 
• 검색이 잘 된다는 것은 변수가 길거나 짧더라도 바로 찾을 수 있기때문에 검색이 잘 되는 이름이 기본적으로 편할 것.
• 그래도 가독성 때문이라도 어느정도 적당한 길이로 적는게 좋아 보임.

복수형은 s를 붙일까 말까

• 복수형 변수를 붙이는 것은 접미어에 s를 붙이는 것인데 아무래도 가독성이 떨어질 수 있음. 
  ex) checkUserNamesUnder2Characters() 라는 함수가 있다면 지금은 빨간색으로 칠했지만 가독성은 떨어질 수 밖에 없음
• 대신 Array나 List 같은 방법으로 사용하는 것도 좋아보임 checkUserNameArrayUnder2Characters()

약어를 쓰는 것이 좋을까? 안쓰는 것이 좋을까?

• 약어를 쓰려고 하면 모두가 알만한 약어라면 사용하는 것이 좋아보임. (가독성이 1순위 라는 것을 까먹지 말것)
  ex)  VeryImportantPerson 을 쓰는 것보단 VIP 는 모두가 아는 약어이기 때문에 더 가독성이 좋아짐.
• 현업에서도 몇몇 서비는 약어를 사용함 
  ex) Amazon Web Service Simple Storage Service => AWS S3
        Clova Extensions Kit => CEK 등등
• 보편적으로 이해할 수 있는 변수라면 약어라도 이해할 수 있게 만들어주는 것이 가장 좋아보임.

중요한 단어를 앞에 쓴다.

• 변수이름을 여러가지로 조합 하려고 하면 순서를 잘 정해야함.
• '총 방문자'라는 변수를 만들고 그대로 번역을 하면 'totalVisitor'가 될 것이지만, 검색이 잘 되는 이름을 기준으로 하면 'visitorTotal'이 우선이 될 것이다. 이유는 total은 다른 곳에서도 사용할 수 있기 때문에 (ex: totalComment, totalPost, totalUser 등등) 오히려 중요한 단어를 앞에 두는 것이 좋다.

함수 이름 짓기

• 함수 이름은 기능 그 자체로 지을 수는 없다. 왜냐하면 클라이언트 쪽에서도 사용하는 부분도 있기 때문이다. 
• 예시
  유저가 등록버튼을 클릭하면 유저 정보가 등록이 된다. 
  1. 문장 그대로 :When the user clicks the register button, the user information will be registered
  2. 클라이언트 쪽 제거 (유저행동제거): the user information will be registered
  3. 관사 접속사 제거 + Camel 표기법으로 변경 : userInformationRegistered
  4. register 가 동사가 되니 앞으로 빼내고 : registerUserInformation
  5. register 대신 Post를 넣어 Http Request 처럼 만들기 : postUserInformation