주석과 이름 규칙

개념 이해하기

한 줄 주석은 //, 여러 줄 주석은 /* */, API 문서는 /** */ 형식입니다. 클래스는 PascalCase, 변수와 메서드는 camelCase, 상수는 UPPER_SNAKE_CASE 관례를 사용합니다.

예제에서 // 이유를 설명하는 주석 부분부터 찾으세요. 선언 타입, 실제 객체와 반환값을 한 줄씩 따라가면서 컴파일 단계에서 잡히는 문제와 실행 중 생기는 문제를 구분하세요.

좋은 이름은 값의 역할과 단위를 드러냅니다. 주석은 코드가 이미 말하는 내용을 반복하지 않고 선택의 이유와 제약을 기록합니다.

Javadoc은 공개 API의 계약, 매개변수, 반환값과 발생 가능한 예외를 문서화할 때 사용합니다.

현재 코드를 먼저 실행해 출력과 타입 흐름을 확인한 뒤 변수 이름을 더 구체적으로 바꾸고 상수를 추가하세요.