[java] Java JHipster의 소스 코드 컨벤션
JHipster는 Java 및 자바스크립트를 기반으로 하는 웹 애플리케이션 개발 프레임워크입니다. 이 프레임워크를 사용할 때 소스 코드를 작성하는 방법에는 몇 가지 컨벤션이 있습니다. 이 문서에서는 JHipster의 Java 코드 컨벤션을 살펴보겠습니다.
1. 들여쓰기
모든 들여쓰기는 공백 4개로 해야 합니다. 탭 문자를 사용하지 않도록 주의해야 합니다. 한 줄에 여러 개의 구문을 작성하지 않고, 한 줄에는 한 개의 구문만 작성하는 것이 좋습니다.
2. 이름 짓기
- 클래스 이름은 대문자로 시작하고 카멜 케이스를 사용해야 합니다. 예:
MyClass - 메서드 이름은 소문자로 시작하고 카멜 케이스를 사용해야 합니다. 예:
myMethod - 변수 이름은 소문자로 시작하고 카멜 케이스를 사용해야 합니다. 예:
myVariable - 상수 이름은 모두 대문자로 작성하고 단어 사이에
_를 사용해야 합니다. 예:MY_CONSTANT
3. 중괄호 사용
중괄호는 항상 다음 줄에 작성해야 합니다. 클래스, 메서드, 조건문, 반복문 등 모든 블록에 중괄호를 사용해야 합니다.
잘못된 예:
public class MyClass {
public void myMethod() {
}
}
올바른 예:
public class MyClass
{
public void myMethod()
{
}
}
4. 주석
주석은 코드의 이해를 돕기 위해 사용되어야 합니다. Javadoc을 사용하여 공개된 메서드와 클래스에 대한 문서를 작성하는 것이 좋습니다.
잘못된 예:
// 이 코드는 어떤 기능을 수행합니다.
public void myMethod()
{
}
올바른 예:
/**
* 이 메서드는 어떤 기능을 수행합니다.
*/
public void myMethod()
{
}
5. 네이밍 컨벤션
- 클래스와 인터페이스 이름은 명사로 작성해야 합니다.
- 메서드 이름은 동사로 작성해야 합니다.
- 불린 타입의 변수 이름은 “is”로 시작하는 동사로 작성해야 합니다.
6. 에러 처리
예외 처리는 필수적으로 해야 합니다. NullPointerException 등의 예외가 발생할 수 있는 부분에 대한 적절한 예외 처리를 해야 합니다.
잘못된 예:
public void myMethod()
{
// NullPointerException 발생 가능성이 있는 코드
}
올바른 예:
public void myMethod()
{
try
{
// NullPointerException 발생 가능성이 있는 코드
}
catch (NullPointerException e)
{
// 예외 처리 로직
}
}
이렇게 JHipster의 Java 코드 컨벤션을 준수하면 코드의 가독성과 유지 보수성을 향상시킬 수 있습니다.