방사청_소프트웨어 코딩규칙_주석 및 명명 규칙

1. 주석 규칙 (Comment Rule)

가. C 프로그램 경우 “/* ～ */”, C++ 프로그램 경우 “/* ～ */” 또는

“// ～”를 사용한다. (단, C 프로그램의 경우 컴파일러가 “// ～”를 지원할 경우에 사용할 수 있다.)

나. 주석 내에는 작성자, 날짜, 수정이력, 기능설명, 설계문서와 연계되는 정보 등의 필수 항목은 반드시 포함한다.

다. 주석 내에는 Nested Comment를 삽입해서는 안된다.

라. 기타 주석 작성은 개발자 특성에 맞는 규칙을 사용하되 조직차원에서의 통일된 지침을 수립하여 적용한다.

마. 소스코드 내 해당내용을 자세하고 정확하게 설명할 수 있는 주석을 작성하고, 작성 된 주석은 파일별 소스코드의 30%이상으로 한다.

※ 계산방법 : 주석문의 수 / 실행문의 수

 

2. 명명 규칙 (Naming Rule)

가. 파일명

1) 함수/클래스일 경우, 파일명을 일치시키고 복수일 경우 파일명은 기능을 잘 설명해 줄 수 있는 명칭으로 한다.

2) 파일의 첫글자는 대문자 또는 소문자로 통일하여 표기한다.

3) 파일을 잘 설명할 수 있는 이름으로 파일명을 작성한다.

 

나. 함수/클래스/메소드명

1) 기능을 잘 표현할 수 있는 명칭을 사용한다.

2) 함수 생성 시 “동사 + (명사)”순으로 한다.

3) 클래스 생성 시 “ClassName" 형태로 조합하되 첫 단어의 글자는 대문자로 작성한다.

4) 클래스, 함수, 메소드명을 작성할 경우, 실제 기능을 유추할 수 있는 단어를 조합하여 작성한다.

 

다. 변수명

1) Scope, Linkage를 구분할 수 있어야 하며, 각각 Internal, Extern을 구분하여 작성한다.

예) “Pointer 변수는 p, Global 변수는 g, Static 변수는 s,

Count 변수는 n” 으로 표기

2) 변수명의 첫 글자는 반드시 문자를 사용하고 31자를 넘기지 않는다.

3) 변수명은 헝가리언, 카멜, 파스칼 표기법 또는 조직 내부 작성지침에 따라 사용한다.

 

라. 매크로명

1) 매크로명은 전체를 대문자 또는 “_”를 사용한다.

2) 파일, 매크로명은 표준에 있는 예약어를 사용하지 않는다.

예) _변수명, scanf, printf 등