[#Java/식별자/Code Templates/Javadoc]

안지은·2022년 7월 19일

Java

식별자

클래스, 메서드, 변수명을 구분하는 이름을 '식별자'라고 한다. 모든 문자열을 식별자로 사용할 순 없다. 식별자를 명명할 때의 규칙들을 지금부터 살펴보자.

🎲 식별자 명명규칙

첫 문자는 '_' (Underscore) , '$', 문자로 시작되어야 하며 숫자는 올 수 없다.
(jdk 1.8부터는 Underscore 홀로 식별자로 사용되지 못 함.)
두 번째 문자부터는 '_' , '$', 문자, 숫자 모두 올 수 있다.
식별자 중간에는 공백이 포함될 수 없다.
대문자와 소문자를 구별한다.
길이 제한이 없다.
예약어나 리터럴로 명명할 수 없다.

예약어

예약어의 종류에는 아래를 참고하자.

리터럴

리터럴이란 변수에 대응되는 값을 의미하며, true, false, null 등이 있다.

🎲 표기법

카멜(Camel) 표기법

맨 첫 번째 문자를 제외한 각 단어의 첫 번째 문자는 대문자로 표기하고, 나머지 문자는 모두 소문자로 표기한다.
ex) internetOfThing

파스칼(Pascal) 표기법

카멜과 동일하나, 맨 첫 번째 문자를 포함한 모든 단어의 첫 번째 문자는 대문자로 표기한다.
ex) InternetOfThing

스네이크(Snake) 표기법

단어와 단어 사이의 공백(띄어쓰기)을 Underscore로 표기한다. (대/소문자 구분 X)
ex) internet_of_thing

케밥(Kebab) 표기법

단어와 단어 사이의 공백(띄어쓰기)을 -(hyphen)으로 표기한다. 프로그래밍에선 사용되지 않는다. (대/소문자 구분 X)
ex) internet-of-thing

Code Templates

Code Templates의 기능을 활용하여 메소드의 주석을 자동으로 만들어주는 방법을 배워보자. Code Templates의 단축기는 Alt + Shift + j이다.

/**
* @param i
* @return
*/
public int getValue(int i) {
	return i;
}

이렇게 자동으로 생성되는 주석의 템플릿을 변경해보자.

Window -> Preferences -> Java -> Code Style -> Code Templates에 들어가서 Comments 아래에 Method를 클릭하자. 그리고 Edit를 눌러 예시로 아래와 같이 편집해보자.

다시 Alt + Shift + j를 눌러 메소드의 주석을 자동으로 생성해보자.

/**
*
* @param i
* @return
* @since 1.0
* 2022. 7. 20.
*/
public int getValue(int i) {
	return i;
}

Javadoc

Javadoc을 활용하여 내가 만든 프로그램을 API로 손쉽게 만드는 방법을 알아보자. 추가로, javadoc.exe 파일이 API를 자동으로 생성해주는 프로그램이다.

우선 아래는 javadoc을 생성할 package chap01의 Sample01 소스 코드이다.

package chap01;

public class Sample01 {

	public static void main(String[] args) {
		// TODO Auto-generated method stub
		int num = 123 ;
		System.out.printf("%d", num);
	}

	/**
	 * 연습
	 * @param i 입력
	 * @return 출력
	 * @since 1.0
	 * 2022. 7. 20.
	 */
	public int getValue(int i) {
		return i;
	}

}