7. Java Code Convention

코딩 컨벤션이란, 코딩을 하는 프로그래머 사이의 규칙이다.

소프트웨어를 개발하는 일련의 모든 과정에 들어가는 비용 중 80%가 유지보수에 쓰여진다.

소프트웨어의 직접 개발한 개발자가 그 소프트웨어의 유지보수를 담당하는 경우는 거의 보기 힘들다.

코딩 규칙을 지키면 다른 개발자가 그 소스 코드를 처음 보았을 때, 더 빠른 시간 안에 완벽하게 이해할 수 있도록 도와주기 때문에, 소프트웨어의 가독성이 높아진다.

아래 링크 블로그에서는 다음과 같은 목차로 코드작성의 규칙을 설명해 주었다.

1. 개요

2. 파일 이름

2.1 파일 확장자

2.2 공통으로 사용되는 파일 이름

3. 파일 구조

3.1 자바 소스 파일

3.1.1 시작 주석

3.1.2 Package 문과 Import 문

3.1.3 Class와 Interface 선언

4. 들여쓰기

4.1 한 줄의 길이

4.2 줄 나누기

5. 주석

5.1 구현 주석 형식

5.1.1 블록(Block) 주석

5.1.2 한 줄(Single-Line) 주석

5.1.3 꼬리(Trailing) 주석

5.1.4 줄 끝(End-Of-Line) 주석

5.2 문서화(Documentation) 주석

6. 선언

6.1 한 줄당 선언문의 수

6.2 초기화

6.3 배치

6.4 클래스와 인터페이스의 선언

7. 문 (Statements)

7.1 간단한 문

7.2 복합문

7.3 return 문

7.4 if, if-else, if else-if else 문

7.5 for 문

7.6 while 문

7.7 do-while 문

7.8 switch 문

7.9 try-catch 문

8. 빈 공간 (White Space)

8.1 한 줄 띄우기 (Blank Lines)

8.2 공백 (Blank Spaces)

9. 명명(Naming) 규칙

9.1 Packages

9.2 Classes

9.3 Interfaces

9.4 Methods

9.5 Variables

9.6 Constants

10. 좋은 프로그래밍 습관

10.1 인스턴스 변수와 클래스 변수를 외부에 노출하지 말고 대신 접근을 제공!

10.2 클래스 변수와 클래스 메서드는 클래스 이름을 사용하여 호출!

10.3 숫자는 바로 사용하지 말고 선언해서 변수 이름으로 접근!

10.4 변수에 값을 할당할 때 주의할 것들!

10.5 그 외 신경써야 할 것들

10.5.1 괄호

10.5.2 반환 값

10.5.3 조건 연산자 '?' 이전에 나오는 식(expression)

11. 코드 예제

11.1 자바 소스 파일 예제

http://myeonguni.tistory.com/1596