표준 코딩 규칙

표준 코딩 규칙을 따를 때 장점

• 가독성이 높아진다.
• 간결하고 명확한 코딩이 가능하다.
• 개발 시간을 단축시킨다.

명칭에 관한 규칙

• 명칭은 31자 이내로 정한다.
• 변수명과 함수명은 다르게 사용한다.
• 명칭의 규칙을 따른다.
  • 매크로명 : _및 대문자 사용
  • 상수명 : _및 대문자 사용
  • 변수명 : 소문자로 시작
  • 함수명 : 소문자로 시작, 첫 번째 단어는 동사로 작성
  • 포인터명 : 참조하는 변수명의 첫 글자는 대문자 사용, 포인터 변수명은 앞에 p를 붙인다.

소스 형식에 관한 규칙

• 소스 파일 하나는 200줄 이내로 작성한다.
• 한 줄의 길이는 80자 이내로 작성한다.
• 함수의 내용은 70줄 이내로 작성한다.
• 하나의 문장을 2줄로 작성하는 경우 다음 규칙을 따른다.
  • 80자가 넘어 쉼표가 오면 다음 문자는 새 줄로 시작한다.
  • 둘째 줄의 시작은 다음의 좋은 예처럼 이전 줄의 표현식과 같게 한다.

//나쁜 예
int a = k (parameter_A, parameter_B, pa
                    rameter_C);
                    
//좋은 예
int a = k (parameter_A, parameter_B,
           prameter_C);

• 여는 중괄호 { 는 문장의 끝에, 닫는 중괄호} 는 문장의 시작에 둔다.

//나쁜 예
if(a>b)
{
    //코드
}

//좋은 예
if(a>b){
    //코드
}

• 수준이 동일한 문장은 시작 위치를 맞춘다.

주석에 관한 규칙

• 코드의 첫 주석에는 다음 내용을 담는다.
  • 최초 작성자
  • 최초 작성일
  • 최초 변경일
  • 목적
  • 개정 이력(변경자, 변경 일자, 변경 내용)
  • 저작권
• 메서드 정의 앞에 다음 내용을 주석으로 추가하고 시작한다.
  • 목적 : 함수의 용도, 목적
  • 매개변수 : 함수의 인자로 사용되는 변수에 대한설명
  • 반환 값 : 함수의 결과 값에 대한 설명
  • 변경 이력 : 함수를 변경한 변경자, 변경 일자, 변경 내용
• 원시 코드와 주석을 명확히 구분한다.
• 원시 코드와 주석이 일치하게 한다. (함수 인자에 대한 설명, 복잡한 논리식, 간단하지 않은 자료구조 등)

변수 선언 및 자료형에 관한 규칙

• 용도가 같은 변수는 한 줄에 작성한다.
• 필요한 변수만 선언한다.
• 배열 선언 시 요소 수를 명시하거나 초기화한다.
• 배열을 초기화할 때는 중괄호를 적절히 사용한다.
• 지역 변수는 선언 시 초기화한다.
• 부호 없는 자료형에는 u를 붙인다.
• 포인터 변수에 주소나 정수 값을 저장할 때는 자료형이 일치해야 한다.
• 비트 필트는 unsigned/signed int형으로만 선언한다.

상수에 관한 규칙

• 8진수는 사용하지 않는다.
• 숫자 리터럴은 const 변수를 사용한다. (C언어의 경우)
• 상수는 부호 있는 자료형을 사용하고 부호 없는 자료형을 사용할 때는 u를 붙인다.

수식에 관한 규칙

• 단한 연산자의 바른 표기
• 이항 연산자의 바른 표기
• 삼항 연산자의 바른 표기
• 증감 연산자의 바른 표기
• 연산자가 3개 이상인 경우의 바른 표기
• sizeof 인자의 바른 표기

//나쁜 예, 좋은 예 ;는 생략

a ++, a++               //단항 연산자의 바른  표기

a=b+c+d, a = b + c + d; //이항 연산자의 바른 표기

a > b ? x: -x,  (a > b) ? x : -x  //삼항 연산자의 바른 표기


sum = kor + (++eng),   

++eng; 
sum = kor + eng;     //증감 연산자의 바른 표기


if(a==0&&b==0),  if((a==0) && (b==0)) //연산자가 3개 이상인 경우의 바른 표기

sizeof(a=b+c),    sizeof(a) //sizeof 인자의 바른 표기

문장에 관한 규칙

• switch 문에서 case 문을 빠져나오기 위해 break 문을 사용한다.
• switch 문에서 case 문이 다 끝나면 default 문을 넣어주어야 한다.
• goto 문을 사용하지 않는다.
• for문을 제어하는 수식에 실수 값을 사용하지 않는다.
• for문을 제어하는 수치 변수를 바르게 사용한다.
• break문은 가능하면 한 번만 사용한다.
• if ~ else 문의 끝은 else 문으로 종료한다.

이상으로 포스팅을 마칩니다. 감사합니다.

 

참고자료

쉽게 배우는 소프트웨어 공학 2판 (8단원 구현)

http://www.kyobobook.co.kr/product/detailViewKor.laf?mallGb=KOR&ejkGb=KOR&barcode=9791156645429