코드 약속의 필요성 ( Java Code Convention)

소개글

자바 프로그래 작성시 코드 규약 요약

목차

1. 코드 규약의 필요성

2. 파일 이름
2-1 파일 확장자
2-2 공통으로 쓰이는 파일 이름

3. 파일 구조

4. 들여쓰기
4-1 한 줄의 길이
4-2 줄 나누기

5. 주석
5-1 BLOCK 주석
5-2 SINGLE-LINE 주석
5-3 TRAILING 주석
5-4 END-OF-LINE 주석
5-5 문서 주석

6. 선언
6-1 한 줄당 선언문의 수
6-2 초기화
6-3 배치
6-4 클래스와 인터페이스의 선언

7. 문장
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. 공백
8-1 빈 줄
8-2 빈 스페이스

9. 이름 붙이는 규약

10. 프로그래밍 습관
10-1 클래스 변수와 instance에 대한 접근을 제공한다.
10-2 클래스 변수와 클래스 Method의 사용
10-3 상수
10-4 변수 할당
10-5 괄호
10-6 리턴 값
10-7 조건부 연산자에서 “?” 전에 표현식

본문내용

1. 코드 규약의 필요성
1. 소프트웨어의 전체 수명 중 80%가 유지보수에 사용된다.
2. 어떤 프로그램이든 프로그램 전체 수명동안 최초 개발자에 의해 유지되기는 매우 어렵다.
3. 코드 약속은 개발자들이 새로운 코드를 더 빠르고 확실하게 이해시킬 수 있게 함으로써 그 소프트웨어의 가독성을 향상시킨다.
4. 만약 당신이 소스 코드를 제품으로 판매하려면 당신이 만든 것과 다른 제품들이 잘 어울리고 통합되어야 할 필요가 있다.

2. 파일 이름
2-1 파일 확장자
- 다음과 같은 확장자를 가진다.
○자바 소스 : .java
○자바 바이트코드 : .class

2-2 공통으로 쓰이는 파일 이름
- GNUmakefile : make파일의 이름, 소프트웨어를 빌드할 때 gnumake를 사용한다.
- README : 디렉토리의 내용을 요약하는 파일 이름.

3. 파일 구조
- 2000라인 이상 되는 파일들은 부담이 되므로 피한다.
- 자바 소스 파일은 다음과 같은 순서를 가진다.

1. 시작주석
아래와 같이 클래스 이름, 버전정보, 날짜, 저작권 주의를 보여주는 주석으로 시작한다.
/*
* 클래스 이름
*
* 버전 정보
*
* 날짜
*
* 저작권 주의
*/
2. Package문장 과 Import문장
- 대부분 자바 소스 파일의 주석을 제외한 첫 번째 라인이 package 문장이다.
- 이후에 import문장이 온다.
3. 클래스와 인터페이스 선언

4. 들여쓰기
- 4개의 스페이스를 들여쓰기의 단위로 사용.
- 들여쓰기의 정확한 구조는 정해져 있지 않다.
- Tab은 4개가 아니라 8개의 Space로 설정한다.

4-1 한 줄의 길이
- 한 줄에 80자 이상 쓰는 것은 대부분의 터미널과 툴에서 다룰 수 없기 때문에 피한다.

4-2 줄 나누기
- 표현이 한 줄에 들어가지 않을 때는, 몇 가지 일반 원칙을 따라서 두 줄로 분리한다.
- 콤마 후에 분리한다.
- 연산자(Operator)전에 분리한다.
- 레벨이 낮은 원칙보다는 레벨이 높은 원칙에 따라서 분리한다.

참고 자료

없음