Coding Conventions/Namings/Architecture Rules

클래스 위 - Documentation Comments

/**
 * 영속성 계층에서 리포지토리를 사용하여 단순한 조회로직을 담당하는 컴포넌트를 'Query' 라고 지정한다.
 * - Query 는 클래스에 적용한다.
 */
public @interface Query {
}

• <br>, <pre>, <li> 등의 html 태그는 사용하지 않음

메서드 위 - Block Comments, Single-Line Comments

/* 좋아요 숫자 업데이트 */
void updateLikeCount(long bookmarkId, ReactionType existedType, ReactionType requestType);

/* 태그 목록 조회 */
List<GetUsedTagWithCountResult> getUsedTagsWithCount(long profileId);

/**
 * 리액션 요청
 * - 사용자는 북마크에 대해 하나의 reaction 만을 가질 수 있다.
 * - 사용자는 reaction 을 등록, 취소, 변경 할 수 있다.
 * 		like,   hate   요청 reactionType   ->  like,    hate
 * 등록	 0       0           like 		 	    1 		0
 * 취소	 1       0           like 		 	    0 		0
 * 변경	 0       1           like 		 	    1 		0
 */
void requestReaction(ReactionCommand command);

• 인터페이스의 메서드에는 주석 필수, 적절한 한글 네이밍 제공

• @Override 메서드의 경우 인터페이스에 주석이 있으므로 생략 가능

• 혹은 더 구체적인 비즈니스 로직에 대한 주석을 Block-Comment 로 작성 가능

코드 내부 - Single-Line Comments

@Override
public void requestReaction(ReactionCommand command) {
...

/* 리액션 요청 */
final ReactionType existedType = profile.requestReaction(bookmark, requestType);

/* 북마크 좋아요 숫자 업데이트 */
bookmarkService.updateLikeCount(bookmarkId, existedType, requestType);
}

테스트 코드

• //given, //when, //then 의 경우 에만 End-Of-Line Comments 사용

• 그 외에는 /* */ - Single-Line Comments 사용