comment template에 대한 논의

[unikal1]

주석 템플릿에 대한 논의입니다.
제가 생각한 형식은

/**
 * 코드에 대한 전체적인 역할을 적습니다.
 * <p>
 * 코드에 대한 작동 원리 등을 적습니다.
 *
 * <p><b>상속 정보:</b><br>
 * 상속 정보를 적습니다.
 *
 * <p><b>주요 생성자:</b><br>
 * {@code ExampleClass(String example)}  <br>
 * 주요 생성자와 그 매개변수에 대한 설명을 적습니다. <br>
 *
 * <p><b>빈 관리:</b><br>
 * 필요 시 빈 관리에 대한 내용을 적습니다.
 *
 * <p><b>외부 모듈:</b><br>
 * 필요 시 외부 모듈에 대한 내용을 적습니다.
 *
 * @author ${USER}
 * @since ${DATE}
 * @see 
 */

다음과 같습니다. 추가적인 요소나, 수정 요소가 있을까요

[s0o0bn]

오호 좋습니다. 제가 느끼기엔 위 내용 정도면 충분할 것 같습니다~

그 빈 관리와 외부 모듈 관련 주석은 감이 잘 안 와서 예시 같은 게 있을까요?

[sjhlko]

저도 궁금하네요~ 리턴이나 예외 throw 에 대한 내용도 필요한 경우에 넣으면 좋겠네요~

[unikal1]

특수한 경우, 가령 prototype이거나, 아니면 config 등에서 수동으로 Bean 어노테이션을 통해 주입한 경우, 해당 appConfig 의 링크 등이겠네요.

[sjhlko]

좋네요~

[unikal1]

리턴이나 예외같은 경우는 메서드 커멘트 템플릿에 따로 작성하려고요. 위는, 클래스 생성 시 자동으로 생성해주는 주석 형식에 대한 것입니다.
외부 모듈은, 그냥 가령 Redis에 관한 내용이나, MySQL 등에 대한 중요한 설정 과 같이, 표시는 외부 모듈이라 했는데 좀 더 자세히 살펴보면 외부 API 기반 기술의 사용 여부라 보면 될 것 같아요

[s0o0bn]

이해했습니다 좋아요~