<개발자의 글쓰기>를 읽고 - 변수명 짓기, 주석 쓰기 철학

<개발자의 글쓰기>를 읽고

 - 변수명 짓기, 주석 쓰기 철학

 

학부시절 과제나 팀플, 현업에서의 경험을 간간히 읽는 개발 교양 서적의 훌륭한 표현들에 투영하여 변수명 짓기, 주석 쓰기 방식에 대해 정리를 하고자 합니다.

계속하여 업데이트 예정이고, 사실 누구에게 보여지기 보다 제 자신을 위한 글이지만, 이런 것들은 서로 공유할수록 좋다고 여겨져 공개글로 작성합니다(인용 문구 문제시 수정예정). 다양한 의견은 언제나 환영합니다!

​

---

변수명 짓기

(클린코드, 개발자의 글쓰기)

---

- 회사에서 사용하는 코딩 룰이 있다면, 그 룰을 최우선적으로 여긴다.

​

- i는 변수 이름이지만(integer), d는 아니다(day, date, double, ...).

​

- 변수 이름의 길이를 신경쓰기 보다는, 검색이 잘되는 이름으로 짓는다.

​

- 복수형의 -s는 그래도 눈에 띄지만, 함수형의 중간 -s들은 눈에 띄지 않는다. 실수를 방지하기 위해서는 -s 대신에 array, list of 등의 대체 표현을 쓴다.

​

- 약어? 서비스 이름, 패키지 이름, 클래스 이름에 쓰는 것은 나쁘지 않다.

​

- 중요한 단어를 앞에 쓴다.

ex. totalVisitor대신 visitorTotal 식으로 사용하면 검색을 보다 빠르고 쉽게할 수 있다!

​

- 함수 이름 짓는 순서

1) 사용자가 할 일을 모두 없앤다.

2) 논리적으로 합쳐야 하거나 떼야 할 것을 정리한다.

3) 정리한 한글을 영어로 번역한다.

4) 번역한 영어에서 불필요한 단어는 빼고 모호한 단어도 명확하게 대체한다.

​

- SMART ===> 개발자의 글쓰기 참고

이름은

검색하기 쉽고

조합하기 쉽고

수긍하기 쉽고

기억하기 쉽고

입력하기 쉽게 만든다.

​

​

---

주석 쓰기

(클린코드, 개발자의 글쓰기)

---

- 이름을 잘 지어서 주석을 줄이자.

​

- 처음부터 주석없이 코드 작성

​

- 주석이 필요할 때는 써야한다. 주석이 제 역할을 하고 있다면 많든 적든 상관 없다.