[convention] naming convention

문돌이 개발자·2023년 7월 27일

프로젝트를 하면서 가장 어려운 것 중 하나가 이름을 붙이는 것이다.

code reader의 입장에서 그리고 나중에 내가 다시 읽었을 때 이름을 보고 무엇을 위한 variable인지 무엇을 하는 method인지 쉽게 파악할 수 있게 하는 것은 아주 어렵다.

이 어려운 naming을 조금이나마 잘하기 위해 2가지 기억해야 할것들이 있다.

naming을 붙일 때 일관성이 있어야 한다.

같은 레벨의 변수명을 camel case와 snake case를 혼용해서 사용하거나
naming을 붙이는 기준을 사용 용도로 했다가 value의 특징으로 하는 등

일관성을 깨는 naming은 혼동을 가져다 줄 수 있다.

method 이름은 method가 하는 일을 한줄로 '잘' 설명해야 한다.

만약 이름에 동사가 여럿 나오고 너무 길어진다는 생각이 들면 method 하나가 여러 method로 분리되어야 함을 의미한다.

만약 동사가 하나고 짧은데 부적절해 보인다면 이름에 무언가 부적절한 naming이 들어갔을 여지가 있다.

까먹고 다시 보려고 남기는 기록