← Back to rules

eslint/capitalized-comments 스타일

An auto-fix is available for this rule.

어떤 기능을 하나요?

주석의 첫 글자를 대문자로 하거나, 하지 않도록 강제합니다.

왜 문제가 되나요?

주석의 대소문자 규칙이 일관되지 않으면 코드를 더 읽기 어려워집니다. 이 규칙은 코드베이스 전체에서 일관된 스타일을 유지하는 데 도움을 줍니다.

예시

기본값 "always" 옵션과 함께 잘못된 코드 예시:

// 소문자 주석
/* 소문자 블록 주석 */

기본값 "always" 옵션과 함께 올바른 코드 예시:

// 대문자 주석
/* 대문자 블록 주석 */
// 123 - 알파벳이 아닌 문자로 시작하는 주석은 무시됨

구성 방법

capitalized-comments 규칙에 대한 구성 방법입니다.

첫 번째 요소는 주석이 항상 "always" 또는 전혀 "never"로 시작하도록 지정합니다. 두 번째 요소는 추가 옵션을 포함할 수 있는 선택적 객체입니다.

1번째 옵션

유형: "always" | "never"

2번째 옵션

이 옵션은 다음 속성을 가진 객체입니다:

block

유형: object

블록 주석 전용 구성 옵션.

block.ignoreConsecutiveComments

유형: boolean

true인 경우, 첫 번째 주석 이후 연속적인 주석은 무시됩니다.

block.ignoreInlineComments

유형: boolean

true인 경우, 코드 중간에 위치한 인라인 주석(내부 주석)은 무시됩니다.

block.ignorePattern

유형: string

정규 표현식 패턴입니다. 해당 패턴과 일치하는 주석은 위반 사항으로 간주되지 않습니다.

ignoreConsecutiveComments

유형: boolean

true인 경우, 첫 번째 주석 이후 연속적인 주석은 무시됩니다.

ignoreInlineComments

유형: boolean

true인 경우, 코드 중간에 위치한 인라인 주석(내부 주석)은 무시됩니다.

ignorePattern

유형: string

정규 표현식 패턴입니다. 해당 패턴과 일치하는 주석은 위반 사항으로 간주되지 않습니다.

line

유형: object

라인 주석 전용 구성 옵션.

line.ignoreConsecutiveComments

유형: boolean

true인 경우, 첫 번째 주석 이후 연속적인 주석은 무시됩니다.

line.ignoreInlineComments

유형: boolean

true인 경우, 코드 중간에 위치한 인라인 주석(내부 주석)은 무시됩니다.

line.ignorePattern

유형: string

정규 표현식 패턴입니다. 해당 패턴과 일치하는 주석은 위반 사항으로 간주되지 않습니다.

사용 방법

구성 파일이나 명령줄 인터페이스에서 이 규칙을 활성화하려면 다음을 사용할 수 있습니다:

Config (.oxlintrc.json)

{
  "rules": {
    "capitalized-comments": "error"
  }
}

CLI

oxlint --deny capitalized-comments

참고 자료

• 규칙 소스