[javascript] 동사형 네이밍 규칙

자바스크립트에서 함수와 메서드의 네이밍은 동사형으로 작성하는 것이 일반적입니다. 동사형 네이밍을 사용하면 코드를 읽을 때 더욱 직관적이고 명확하게 이해할 수 있습니다. 이 글에서는 동사형 네이밍 규칙을 몇 가지 예시와 함께 알아보겠습니다.

1. 동작을 나타내는 동사 사용

함수나 메서드 이름에는 해당 함수가 어떤 동작을 수행하는지를 나타내는 동사를 사용하는 것이 좋습니다. 예를 들어, “save”, “delete”, “fetch”와 같은 동사를 사용함으로써 코드의 의도를 명확하게 전달할 수 있습니다.

function saveData(data) {
  // 데이터를 저장하는 동작 수행
}

function deleteItem(itemId) {
  // 아이템을 삭제하는 동작 수행
}

function fetchData() {
  // 데이터를 가져오는 동작 수행
}

위의 예시에서는 각각 saveData, deleteItem, fetchData라는 함수들이 어떤 동작을 수행하는지 명확하게 알 수 있습니다.

2. 동작의 주체를 명시

동사형 네이밍을 할 때에는 해당 동작을 수행하는 주체를 함께 명시하는 것이 좋습니다. 이를 통해 코드를 읽는 사람이 함수를 사용할 때 어떤 주체에 대해 동작을 수행하는지 명확하게 알 수 있습니다. 예를 들어, “saveUser”, “deleteProduct”, “fetchUserData”와 같은 네이밍이 좋은 예시입니다.

function saveUser(user) {
  // 사용자 정보를 저장하는 동작 수행
}

function deleteProduct(productId) {
  // 제품을 삭제하는 동작 수행
}

function fetchUserData(userId) {
  // 사용자 데이터를 가져오는 동작 수행
}

위의 예시에서는 saveUser, deleteProduct, fetchUserData라는 함수들이 각각 어떤 주체에 대해 동작을 수행하는지 명확하게 알 수 있습니다.

3. 함수의 반환 값에 대한 정보 제공

함수의 이름을 작성할 때 반환 값에 대한 정보를 함께 제공하는 것이 좋습니다. 이를 통해 코드를 읽는 사람이 어떤 값을 기대할 수 있는지 예상할 수 있습니다. 예를 들어, “calculateSum”과 같은 네이밍은 함수가 합계를 계산한다는 것을 알려줍니다.

function calculateSum(numbers) {
  // 숫자들의 합계를 계산하여 반환하는 동작 수행
  return sum;
}

위의 예시에서는 calculateSum 함수가 합계를 계산하여 반환한다는 것을 명확히 알 수 있습니다.

결론

자바스크립트에서 함수와 메서드의 네이밍은 동사형으로 작성하는 것이 좋습니다. 동작을 나타내는 동사를 사용하고, 동작의 주체를 명시하며, 함수의 반환 값에 대한 정보를 제공하는 것이 좋습니다. 이러한 네이밍 규칙을 따르면 코드를 더욱 명확하게 이해할 수 있고, 유지 보수하기 쉬운 코드를 작성할 수 있습니다.

참고 자료