함수와 메소드는 프로그래밍에서 중요한 역할을 수행합니다. 이들을 작성할 때에는 몇 가지 규칙을 준수하는 것이 좋습니다. 아래에는 JavaScript를 기준으로 함수와 메소드를 작성할 때 유용한 규칙을 정리하였습니다.

1. 함수의 이름

• 함수의 이름은 식별적이고 명확해야 합니다.
• 함수의 이름은 동사로 시작하는 것이 좋습니다.
• 카멜케이스(camel case)를 사용하여 함수의 이름을 작성합니다. 예를 들면: calculateScore, getUserDetails 등.

2. 함수의 매개변수

• 매개변수의 이름은 명확하고 의미 있게 작성되어야 합니다.
• 매개변수의 개수는 최소화하는 것이 좋습니다.
• 필요한 경우 매개변수에 기본값을 설정하여 선택적으로 사용할 수 있도록 합니다.

function calculateScore(name, age, score = 0) {
  // 함수의 내용
}

3. 함수의 반환 값

• 함수가 반환하는 값을 명확하게 정의하여 사용자가 쉽게 이해할 수 있도록 합니다.
• 함수의 반환 값이 없을 경우 void를 사용하거나 undefined를 반환합니다.

function calculateScore(name, age) {
  // 함수의 내용
  return 10;
}

4. 메소드의 작성

• 메소드는 객체에 소속되어 해당 객체의 동작을 수행합니다.
• 메소드의 이름은 명사나 명사구로 정의되어야 합니다.
• 메소드의 이름은 동사로 시작하지 않아야 하며, 대신 동사나 전치사를 사용하여 명사를 완성합니다.

const user = {
  name: 'John',
  age: 30,
  getAddress() {
    // 메소드의 내용
  }
};

5. 주석 작성

• 함수와 메소드의 작성 시 주석을 명확하고 간결하게 작성합니다.
• 주석은 함수 또는 메소드의 역할, 매개변수, 반환 값 등을 설명해야 합니다.
• JSDoc 스타일을 사용하여 함수 또는 메소드에 대한 문서화 정보를 작성할 수 있습니다.

/**
 * 사용자의 나이를 계산하여 점수를 반환하는 함수입니다.
 * @param {string} name - 사용자의 이름
 * @param {number} age - 사용자의 나이
 * @returns {number} - 계산된 점수
 */
function calculateScore(name, age) {
  // 함수의 내용
  return score;
}

함수와 메소드를 작성할 때 위의 규칙을 따른다면 코드의 가독성과 유지 보수성을 향상시킬 수 있습니다.