docs(agent-rules): 테스트와 주석 작성 규칙을 보강한다
This commit is contained in:
@@ -83,11 +83,19 @@
|
||||
- 생성자 주입(primary constructor + `private val`)을 기본으로 사용한다.
|
||||
- 필드 주입보다 명시적 생성자 주입을 우선한다.
|
||||
|
||||
### 10) 주석
|
||||
- 의미 단위별로 주석을 작성한다.
|
||||
- 주석은 한 문장으로 간결하게 작성한다.
|
||||
- 주석은 코드의 의도와 구조를 설명한다.
|
||||
- 주석은 코드 변경 시 업데이트를 잊지 않는다.
|
||||
|
||||
## 테스트 스타일 규칙
|
||||
- 테스트 프레임워크: JUnit 5 (`useJUnitPlatform()`)
|
||||
- 목킹: Mockito 사용 패턴 존재 (`Mockito.mock`, ``Mockito.`when`(...)``)
|
||||
- 검증: `assertEquals`, `assertThrows` 패턴 준수.
|
||||
- 테스트 이름은 의도가 드러나는 영어 문장형(`should...`)을 유지한다.
|
||||
- 테스트는 DisplayName으로 한국어 설명을 추가한다.
|
||||
- 예외 상황이 있는지 확인하고 예외 상황에 대한 테스트 케이스를 추가한다.
|
||||
|
||||
## 설정/보안 유의사항
|
||||
- `application.yml`은 다수의 `${ENV_VAR}`를 사용한다.
|
||||
|
||||
Reference in New Issue
Block a user