[ECCS] 소스 파일

4. 모듈 규정

4. 3 소스 파일

규정

1. 각 소스 파일에는 하나의 entity를 제어하는 적절한 동작만 포함해야 한다. entity의 예로는 캡슐화된 데이터 타입, 활성 객체, 주변장치 드라이버(예: UART), 통신 프로토콜 또는 계층(예: ARP) 등이 있다.
2. 각 소스 파일에는 다음 섹션의 일부 또는 전부가 열거된 순서대로 구성되어야 한다. 주석 블록, #include문, 데이터 유형, 상수 및 매크로 정의, 정적 데이터 선언, private 함수 프로토타입, public 함수 몸체 그리고 private 함수 몸체.
3. 각 소스 파일은 컴파일러가 public 함수와 해당 프로토타입이 일치하는지 확실히 할 수 있도록 동일한 이름의 헤더 파일을 포함해야 한다(예: 파일 adc.c에는 #include "adc.h" 문장이 있어야 함).
4. 파일의 절대 경로는 #include문 내에 사용할 수 없다.
5. 소스 파일에는 사용하지 않는 include 파일이 없어야 한다.
6. 소스 파일은 다른 소스 파일을 #include 문에 포함해서는 안 된다.

이유

소스 파일의 목적 및 내부 레이아웃은 그것을 다루는 모든 사람에게 명확해야 합니다. 예를 들어, public 함수는 일반적으로 가장 관심이 많으므로 private 함수보다 먼저 표현됩니다. 중요한 점은 컴파일러 입장에서 모든 함수 선언이 프로토타입과 일치해야 한다는 것입니다.

시행

정적 분석 도구를 사용하여 실제로 사용하지 않는 파일이 포함되어 있는지 확인 가능합니다. 다른 규칙들은 코드 검토중 시행됩니다.