• 📄

Java doc

Method

• 입력값, 리턴값, 에러 작성

/**
*   문자열을 다른 T의 타입으로 변환    // 함수 설명
*
*   @throws IndexOutOfBoudsException    // 예외 발생
*           beginIndex 또는 endIndex가 0보다 작은 경우
*           endIndex가 length()보다 큰 경우
*
*   @param string 변환할 문자열    // 파라미터 설명
*   @param type   주어진 문자열을 변환할 목표 타입
*   @param <T>    element의 타입
*   @param <V>    element의 값
*
*   @return 변환된 문자    // 리턴값 설명
 */
public String convert(String string, Class<T> type)

Class

• 클래스의 목표, 작성자 작성

/**
 *  Javadoc 테스트용 클래스
 * 
 *  @author jegarnet
 */

Coding Convention

<aside> ⌨️ 자동 정렬 단축키 : Ctrl + Alt + L

</aside>

• import 할 때 와일드 카드(*)로 가져오지 않기

• {} 괄호 생략하지 않기

• 들여쓰기는 4공백

• 각 상태가 끝나면 개행하기(; 기준)

• 연산자 같은 상징들 앞에서 끊어서 개행하기 (., catch block)

  User user = User.builder()
  								.id("aaa")
  								.build();
  

• Annotation은 한 줄씩 작성

• Naming

  ⚠변수명 생략해서 작성하지 않을 것⚠

  • Class : UpperCamelCase, 명사나 명사구로 작성(Interface 포함)
  • method : lowerCamelCase, 동사로 작성(sendMessage, stop)
  • CONSTANT : CONSTANT_CASE
  • field : loweCamelCase, 명사절로 작성

• catch 블록은 비워두지 않기

• static 멤버는 클래스 이름을 활용해서 호출할 것

  Foo foo = new Foo();
  Foo.aStaticMethod();    // good
  foo.aStaticMethod();    // bad