다국어 docstring/코멘트 관리

다국어 docstring/코멘트 관리

다언어 지원 docstring/코멘트를 체계적으로 관리하고, 고품질 문서를 유지합니다.

사용법

# 언어를 자동 검출해서 실행
「docstring 이 없는 클래스·함수에 추가하고, 기준을 만족하지 않는 코멘트를 업데이트하세요」

# 언어를 지정해서 실행
/update-doc-string --lang python
「Python 파일의 docstring 을 PEP 257 준수로 업데이트하세요」

# 특정 디렉터리의 문서 정비
「src/components/ 하위의 함수에 JSDoc 을 추가하세요」

옵션

• --lang <en|ko> : 문서의 기술 언어(기본값: 기존 코멘트에서 자동 판정, 없으면 en)
• --style <스타일> : 문서 스타일을 지정(언어 고유의 기본값 있음)
• --marker <true|false> : Claude 마커를 부여할지(기본값: true)

기본 예제

# 1. 대상 파일의 분석(프로그래밍 언어는 자동 검출)
find . -type f \( -name "*.py" -o -name "*.js" -o -name "*.ts" -o -name "*.dart" -o -name "*.go" -o -name "*.rs" \) | grep -v test
「docstring 이 부족한 요소(코멘트 행수 0 또는 30 자 미만)를 특정하세요」

# 2. 문서 추가(언어 자동 판정)
「특정된 요소에 언어 고유의 필수 요소를 포함하는 docstring 을 추가하세요」
# → 기존 코멘트에 한국어가 있으면 한국어로, 없으면 영어로 기술

# 3. 문서 추가(명시적으로 영어 지정)
/update-doc-string --lang en
「Add docstrings with required elements to the identified elements」

# 4. 마커 확인