Java Code Convention

Abstract

---

Java Programming 시 지켜야 할 개발팀 code format / naming rule 을 정의하고 이를 공유/적용한다.

What is Code Convention?

Java code 작성시 지켜야 할 일종의 룰 혹은 규약이라 할 수 있다. Code Format, Class/ Method/ Variable Naming Rule 등 여러가지 내용을 담고 있고, 이를 따르도록 권장하고 있다. 'convention' 이라는 단어의 사전적 의미에서 알 수 있듯이 말그대로 '관습', '관례'인 것이다. 결국, 필연적으로 지켜야 하는 것은 아니지만 '통상 그렇게 사용되어 왔고, 룰을 지키는 것이 여러 방면에서 좋다더라'라고 봐도 무방하다는 것이다.

Helpful Documents

Summary	Contents	Type	Description
Code Convention for the Java Programming Language	http://www.oracle.com/technetwork/java/codeconvtoc-136057.html	HTML	Oracle에서 배포/관리 중인 원문. (영문)
Code Convention for the Java Programming Language	codeconventions-150003.pdf	PDF	Oracle에서 배포/관리 중인 원문의 PDF 버전. (영문)
Code Convention for the Java Programming Language	Java_Code_Conventions_Kor.pdf	PDF	한글로 번역된 문서. (버전은 알 수 없음)

Eclipse Settings for Code Convention

---

Eclipse를 사용하면서 어떠한 프로젝트에서 작업을 하더라도 Java Code Foramt을 일정하게 유지하기 위해 Code Style을 설정해준다. 우측의 파일 목록에서 Java Code Styling이 적용된 설정을 다운로드 받고, 아래의 방법을 통해 각각 자신의 Eclipse에 적용하도록 한다.

Importing java code clean-up setting

1. Windows > Preferences 이동
2. Java > Code Style > Clean Up 메뉴 선택
3. 설정 화면에서 'Import' 버튼 클릭.
4. 'sirius-java-cleanup-settings.xml' 선택 후 OK

Importing java code templates settings

1. Windows > Preferences 이동
2. Java > Code Style > Code Template 메뉴 선택
3. 설정 화면에서 'Import' 버튼 클릭.
4. 'sirius-java-code-template-settings.xml' 선택 후 OK

Importing java code formatter settings

1. Windows > Preferences 이동
2. Java > Code Style > Formatter 메뉴 선택
3. 설정 화면에서 'Import' 버튼 클릭
4. 'sirius-java-formatter-settings.xml' 선택 후 OK

 

Configuring Save Action

---

Java 에디터에서 코드 작성 후 저장 했을 경우 코드 내용을 정리해주는 Action을 정의 할 수 있습니다.

• Windows > Preferences
• Java > Editor > Save Actions
• 아래 항목들을 체크 활성화
  • Perform the selected actions on Save
    • Format source code
      • Format all lines
    • Organize imports

위와 같이 설정하면, Java 소스의 저장 액션이 발생 할 때마다 정해진 규칙에 따라 코드 포매팅을 수행합니다. 코드 포매팅의 기준은 이전 섹션에서 설정한 Java Code Formatter Settings를 기준으로 합니다.

codeconventions-150003.pdf

java-cleanup-settings.xml

java-code-template-settings.xml

java-formatter-settings.xml

Java_Code_Conventions_Kor.pdf