[실전 API 설계] - 02. 개발 시간을 줄여주는 이름 짓기와 주석 쓰기(1)

2026-05-01

01 네이밍 컨벤션, 이유를 알고 쓰자

이름 짓기는 무에서 유를 창조하는 것이 아니다.

인기 있는 자바 소스의 네이밍 규칙

CSS에서 사용하는 BEM(Block, Element, Modifier) 표기법은 '대상__요소--상태'로 작성한다.

.form__button--disable {}

검색하기 쉬운 이름은 고전적 범주화를 이용해 한 단계 상위 범주의 이름을 태그처럼 덧붙인다.

에러 메시지라면 ERROR를 붙이는 식으로 구분하는 것.

문제는 같은 접두어를 가진 함수나 변수가 너무 많아지면 의미가 없어진다.

속성으로 이름을 만들어내는 것(strong_text)은 좋은 방법이 아니므로 개념(title)으로 이름을 짓는다.

그렇지만 이 경우도 스타일 이름을 계속 지어야 하므로, 좋은 방법은 개발 언어의 문법과 조합하는 것.

HTML에서 h1, h2, h3 등 이미 체계를 가진 태그들과 조합(h1.title)하면 기존 태그와 조합해 하나의 이름을 재활용할 수 있다.

이름 자체의 논리적 정합성보다는 그 상황에서 그 이름이 마땅한지에 관한 법. 일시적으로 사용되는 등 구별할 필요가 없다면 이름을 지을 필요가 없다.

시청각적으로 잘 지은 이름은 연상어를 떠올려 기억을 돕는다.

이미 널리 알려진 용어는 바꾸지 않고 쓰는 것이 효율적이다.

요즘은 IDE에서 자동완성을 도와 오타를 낼 확률이 현저히 줄어든 것 같다.