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

 

• 이름 짓기 : 기존 방식이나 이름을 차용해서 새 이름 짓기, 가독성과 소통이 최우선!

"오픈소스의 네이밍 특징들"

• 자바 네이밍 컨벤션 철저히 준수
• 네이밍은 보통 16글자, 3단어 조합
• 주로 명사, 동사, 형용사 조합

네이밍 컨벤션은 기본적으로 영어 표기법 준수

• 클래스 이름 : 주로 모든 단어 첫 글자를 대문자로 쓰는 파스칼 표기법 (ex. CoffeeMenu)
• 함수, 변수 이름 : 주로 첫 단어 빼고 나머지 단어 첫 번째 글자만 대문자로 쓰는 카멜 표기법 (ex. totalCount = 0)
• 상수 : 모두 대문자 표기, 언더스코어(_)로 단어 연결
• 패키지, 모듈 : 소문자로만 씀 (ex. import developerwriting)

BEM 표기법 (Block, Elemenr, Modifier) : 대상-요소-상태

.form {}
.form_button {}
.form_button--disabled {}

변수 이름은 정확하고 가독성 높게 짓기, 여러 단어로 조합할 때는 순서를 잘 정하기

 

패키지, 클래스, 모듈, 함수, 변수가 좋은 이름인지 확인하는 5가지 기준

  - 검색하기 쉽고 (특정 대상을 묶어서 상위 범주 만들어 이해하기)

  - 조합하기 쉽고 (개발 언어 문법과 조합하여 이름 짓기)

  - 수긍하기 쉽고

  - 기억하기 쉽고

  - 입력하기 쉽고 (오타 내기 쉬운 단어가 아닌지 검토)

 

이름이 주석이 할 일을 대신하기 때문에 좋은 코드에는 주석이 없다!

(주석 없이도 쉽게 이해할 수 있는 좋은 코드를 쓸 수 있도록 노력하자!)

 

주석이 제 역할에만 충실하다면 많고 적고는 상관 X

 

 

http://www.yes24.com/Product/Goods/79378905

개발자의 글쓰기 - YES24