(함수) 이름짓기

함수는 어떤 동작을 수행하기 위해 코드를 모아놓은 것이다.

따라서 함수의 이름은 대개 동사이다.

함수 이름은 가능한 한 간결하고 명확하게 해야한다.

코드를 읽은 사람은 함수 이름만 보고도 함수가 어떤 기능을 하는지 힌트를 얻을 수 있어야 한다.

 

함수가 어떤 동작을 하는지 축약해서 설명해주는 동사를 접두어로 붙여 함수 이름을 만드는게 관습이다.

다만 팀 내에서 그 뜻이 반드시 합의된 접두어만 사용해야 한다.

 

show - 대개 무언가를 보여주는 함수

get - 값을 반환함

calc - 무언가를 계산함

create - 무언가를 생성함

check - 무언가를 확인하고 불린값을 반환함

 

showMessage()  //메세지를 보여줌.
getAge()  // 나이를 나타내는 값을 얻고 그 값을 반환함.
calcSum()  // 합계를 계산하고 그 결과를 반환함.
createForm()  // form을 생성하고 만들어진 form을 반환함.
checkPermission()  // 승인 여부를 확인하고 true나 false를 반환함.

---

함수는 동작 하나만 담당해야 한다.

함수는 함수 이름에 언급되어있는 동작을 정확히 수행해야 하며, 그 이외의 동작은 수행해선 안된다.

 

독립적인 두 개의 동작은 독립된 함수 두 개에서 나눠서 수행할 수 있게 해야한다.

한 장소에서 두 동작을 동시에 필요로 하는 경우에는 제 3의 함수를 만들어 두 함수를 호출하는 등의 작업을 해야한다.

 

 

예를 들어....

• getAge 함수는 나이를 얻어오는 동작만 수행해야 한다. alert창에 나이를 출력해주는 동작은 이 함수에는 들어가지 않는게 좋다.
• createForm 함수는 form을 만들고 이를 반환하는 동작만 해야한다. form을 문서에 추가하는 동작이 해당 함수에 들어가 있으면 좋지 않다.
• checkPermission 함수는 승인 여부를 확인하고 그 결과를 반환하는 동작만 해야한다. 승인 여부를 보여주는 메세지를 띄우는 동작이 들어가 있으면 좋지 않다.