// formatters
Remove YAML Comments.
Remove all comments and blank lines from a YAML document while preserving structure and quoting.
YAML input
Stripped
자주 묻는 질문
인라인 주석도 제거하나요?
네, 완전한 줄 주석과 인라인 주석 모두 제거합니다.
일부 주석을 유지할 수 있나요?
아니요, 모든 주석이 제거됩니다.
YAML 구조가 유지되나요?
네, 주석만 제거되며 구조, 타입, 값은 유지됩니다.
YAML 주석을 제거해야 하는 이유
YAML 파일에서 주석을 제거하면 파일 크기가 줄어들고, 읽기 쉬운 본문만 남게 됩니다. 설정 파일을 프로덕션 환경에 배포할 때 주석은 불필요한 오버헤드가 될 수 있습니다.
주석이 포함된 YAML 파일을 파싱할 때 일부 파서는 주석을 무시하지만, 다른 파서는 오류를 일으킬 수 있습니다. 주석을 제거하면 호환성이 향상됩니다.
YAML 파일을 다른 형식(JSON, XML 등)으로 변환할 때 주석이 원본 형식에만 존재하므로, 변환 전에 제거하는 것이 권장됩니다.
주석 처리 세부사항
YAML 주석은 `#` 문자로 시작하며, 행의 끝까지가 주석 범위입니다. # 앞에 공백이 있든 없든 주석으로 인식됩니다.
문자열 값 내부의 `#`는 주석으로 처리되지 않습니다. 다만, 따옴표로 감싸지 않은 문자열에서 '#' 앞에 공백이 있으면 주석으로 해석될 수 있으므로 주의가 필요합니다.
인라인 주석(값 뒤에 오는 주석)과 전체 행 주석 모두 제거됩니다. 빈 줄은 그대로 유지됩니다.
이 도구를 사용해야 하는 경우
프로덕션 배포 전 설정 파일을 정리할 때 주석을 제거합니다. 불필요한 정보를 제거하고 깔끔한 설정만 유지합니다.
YAML 파일을 JSON으로 변환하기 전에 주석을 제거해야 합니다. JSON은 주석을 지원하지 않으므로, 변환 과정에서 오류가 발생할 수 있습니다.
CI/CD 파이프라인에서 YAML 파일을 자동으로 처리할 때 주석 제거를 전처리 단계로 적용할 수 있습니다.