ESLint 규칙 중 capitalized-comments란?

capitalized-comments

ESLint 규칙 중 capitalized-comments란?

capitalized-comments 규칙은 주석의 첫 글자가 항상 대문자로 시작하도록 강제하는 규칙입니다. 이는 주석이 더 명확하고 일관성 있게 보이도록 만들어줍니다.

왜 필요한가?

코드에서 주석은 중요한 설명을 제공하므로 이를 잘 작성하는 것이 중요합니다. 대문자로 시작하는 주석은 시각적으로 더 잘 구분되며, 주석이 명확하게 전달됩니다. 일관된 주석 스타일을 유지함으로써 코드의 가독성이 향상되고, 협업 시 주석을 쉽게 이해할 수 있습니다.

잘못된 예시

주석이 소문자로 시작하는 경우 규칙을 위반하게 됩니다.

// this is a comment

올바른 예시

주석이 대문자로 시작하면 규칙에 맞는 올바른 주석입니다.

// This is a comment

규칙 사용하기

capitalized-comments 규칙을 사용하려면 ESLint 설정 파일 .eslintrc에 다음과 같이 규칙을 추가해야 합니다.

{
  "rules": {
    "capitalized-comments": ["error", "always", { "ignorePattern": "pragma|ignored" }]
  }
}

이 설정은 주석이 대문자로 시작되지 않는 경우 ESLint가 오류를 발생시키도록 합니다.

결론

capitalized-comments 규칙은 주석을 일관성 있게 대문자로 시작하도록 강제하여 주석의 가독성을 높이고, 코드의 스타일을 정돈하는 데 기여합니다. 이를 통해 코드 작성 시 더 깔끔하고 읽기 쉬운 주석을 남길 수 있습니다.