Project Comments - (2) Layout

1. File Layout

 앞서 설명한 File heading 에 이어 다음의 내용을 적어준다.

/** ***************************************************************************** **
 ** includes                                                                                                         **
 **  ***************************************************************************** **/

include 되는 헤더파일을 작성.

파일 위치 경로는 makefile 에 작성.

/** ***************************************************************************** **
 ** defines                                                                                                           **
 **  ***************************************************************************** **/

#define 이용한 constant, function macro 의 순서로 작성.

/** ***************************************************************************** **
 ** typedef                                                                                                           **
 **  ***************************************************************************** **/

스트럭쳐.

/** ***************************************************************************** **
 ** globals                                                                                                           **
 **  ***************************************************************************** **/

2개 이상의 파일에서 공유되는 전역변수.

/** ***************************************************************************** **
 ** locals                                                                                                             **
 **  ***************************************************************************** **/

이 파일에서만 사용되는 변수.

/** ***************************************************************************** **
 ** forward declarations                                                                                        **
 **  ***************************************************************************** **/

함수 프로토 타입정의

2. Function Comments

- 각 function definition 에 관한 정보 작성.
- 각 function definition 의 앞부분에 위치.

-  형 태

   /** ************************************************** **
    ** Functions : Function name                                    **
    ** Synopsis : Function 이 사용하는 알고리즘 등을 기술  **
    ** External Effects : 참조되는 전역변수                       **
    ** Parameters : 파라미터의 의미                                 **
    ** Return : 리턴값 및 의미                                            **
    ** Error : 에러 발생시 리턴되는 값과 의미                       **
    ** *************************************************** **/

3. Layout

3.1 Source File

 - 한줄에 하나의 명령문 사용.
 - 한 line 은 80 column 을 넘지 않는다.
 - 한 function 내의 실행문은 300 ~ 500 라인을 넘기지 않는다.(주석포함시 600 ~ 1000)