Appearance
코드와 같은 줄에 주석을 사용하는 것을 금지합니다.
코드 줄의 끝에 주석을 두면 코드를 더 어렵게 읽을 수 있습니다. 수직으로 스캔할 때 쉽게 놓치기 쉽고, 줄 길이를 늘립니다. 주석을 별도의 줄로 옮기면 주석이 더 부각되고 줄 길이도 줄어듭니다.
이 규칙에 잘못된 코드 예시:
var a = 1; // 줄 내부 주석 var b = 2; /* 다른 줄 내부 주석 */
이 규칙에 올바른 코드 예시:
// 자체 줄에 있는 주석 var a = 1; /* 자체 줄에 있는 블록 주석 */ var b = 2;
이 규칙은 다음 속성을 가진 구성 객체를 수용합니다.
type: string
string
일정한 줄 내부 주석을 무시하기 위한 정규식 패턴입니다.
이 패턴과 일치하는 주석은 보고되지 않습니다.
예시 구성:
{ "no-inline-comments": ["error", { "ignorePattern": "webpackChunkName" }] }
이 규칙을 구성 파일 또는 명령줄 인터페이스에서 활성화하려면 다음을 사용할 수 있습니다:
{ "rules": { "no-inline-comments": "error" } }
oxlint --deny no-inline-comments
eslint/no-inline-comments Pedantic
무엇을 하는가
코드와 같은 줄에 주석을 사용하는 것을 금지합니다.
왜 나쁜가요?
코드 줄의 끝에 주석을 두면 코드를 더 어렵게 읽을 수 있습니다. 수직으로 스캔할 때 쉽게 놓치기 쉽고, 줄 길이를 늘립니다. 주석을 별도의 줄로 옮기면 주석이 더 부각되고 줄 길이도 줄어듭니다.
예시
이 규칙에 잘못된 코드 예시:
이 규칙에 올바른 코드 예시:
구성
이 규칙은 다음 속성을 가진 구성 객체를 수용합니다.
ignorePattern
type:
string일정한 줄 내부 주석을 무시하기 위한 정규식 패턴입니다.
이 패턴과 일치하는 주석은 보고되지 않습니다.
예시 구성:
사용 방법
이 규칙을 구성 파일 또는 명령줄 인터페이스에서 활성화하려면 다음을 사용할 수 있습니다:
참조