1.3 KiB
1.3 KiB
| name | description | type |
|---|---|---|
| 코드 주석 작성 시 날짜 포함 | 파일 생성/수정 중 주석을 달 때는 그날의 날짜(YYYY-MM-DD)를 함께 적을 것 | feedback |
파일을 생성하거나 수정할 때 주석을 추가하는 경우, 작성 날짜(YYYY-MM-DD)를 반드시 포함할 것.
Why: 사용자가 변경 이력 추적과 컨텍스트 파악을 쉽게 하기 위함. 주석만 보고도 언제 적힌 것인지 알 수 있어야 git blame을 거치지 않고도 시간 흐름을 파악 가능.
How to apply:
- 새로 다는 주석 모두 적용 대상 (한 줄 주석, 블록 주석, JavaDoc, XML 주석 등 형식 무관)
- 형식 예시:
- Java/JS 한 줄:
// 2026-05-06 cha: 발전 시뮬레이션 정렬 로직 추가 - Java JavaDoc:
* @since 2026-05-06 - XML/HTML:
<!-- 2026-05-06: FILE appender 활성화 --> - SQL:
-- 2026-05-06: 인덱스 힌트 추가
- Java/JS 한 줄:
- 날짜는 항상 시스템 컨텍스트의
currentDate(오늘) 기준 절대 날짜로 적을 것 ("어제", "오늘" 같은 상대 표현 금지) - 기존 주석을 단순히 읽거나 보존하는 경우는 해당 없음 — 새로 작성하는 주석에만 적용
- 코드 자체에 주석 추가가 불필요한 경우(자명한 코드)에는 주석 자체를 달지 않는 기존 원칙 유지 (이 규칙은 "주석을 달 때"의 형식 규약)