<aside> 💡 This template documents how to review code. Helpful for new and remote employees to get and stay aligned.

</aside>

이름 지정 규칙(Naming Rule)의 필요성

다수의 API에서 오랜 시간이 지나더라도 일괄적인 개발자 환경을 제공하려면 API에서 사용하는 이름이 모두 다음과 같아야 한다.

대부분 개발자들은 영어를 모국어로 사용하는 사람이 아니기 때문에, 이러한 이름 지정 규칙은 대다수 개발자들이 쉽게 이해할 수 있도록 하는 데 한 가지 목적이 있다. 이를 위해서는 메소드와 리소스의 이름을 지정할 때 단순하고, 일괄적이고, 적은 어휘를 사용해야 한다.

📌이름 지정 규칙

구글(Google)에서 채택하고 있는 이름 지정 규칙 3가지.

단순해야 한다.
직관적이어야 한다.
일괄적이어야 한다.

단순함(Simplicity)

코드 리뷰 시, 원활한 의사 소통이 가능해진다.

직관적(Intuitive)

가능하다면 직관적이고 친숙한 용어 사용하여 이름을 지정하면, 코드의 리뷰나 생산성 향상에 도움이 된다. 예를 들어 리소스를 삭제하는 method일 경우, erase보다는 친숙한 delete 또는 remove가 좋을 것이다. 그리고 지나치게 일반적인 모호한 이름을 사용하지 않는 것이 좋다. 이로 인해 API 개념을 혼동할 수 있다. 오히려 API 개념을 정확하게 설명하는 구체적인 이름을 선택하는 것이 좋다. 예를 들어, const customerId;이 코드는 모든 개발자들이 "고객ID"의 정보를 담는 변수라는 것을 확실하게 알 것이다. 축약어를 사용해야 하는 경우에는 "일반적"으로 인정되는 줄임말 또는 축약어를 사용하는 것이 좋다. 예로는 Application Programming Interface보다는 API가 권장되는 것이 좋다.

일괄적(Batch)

API 개발 시, 표기법을 정해놓고 공통된 표기법을 사용하는 것. 공통된 문법을 사용하는 것.

Function batchExample () {
	console.log("Example Code");
};

const batch_example_arrow = () => {
	console.log("Example Code");
};

💡프로젝트 이름