[ECCS] 데이터형 명명 관례

5. 데이터형 규정

5. 1 명명 관례

규정

1. 구조체(structure), 유니언(union) 및 열거(enumeration)를 포함한 모든 새로운 데이터형의 이름은 소문자와 단어 내부의 밑줄로만 구성되어야 하며 ‘_t‘로 끝나야 한다.
2. 모든 새로운 구조체, 유니언형 및 열거형은 typedef 통해 명명되어야 한다.
3. 모든 public 데이터형의 이름은 모듈 이름과 밑줄을 앞에 붙여야 한다.

예시

typedef struct
{
  uint16_t count;
  uint16_t max_count;
  uint16_t _unused;
  uint16_t control;
  
} timer_reg_t;

이유

데이터형 이름과 변수 이름은 종종 유사합니다. 예를 들어, 주변장치에서 타이머 제어 레지스터 세트가 'timer_reg' 이름을 호출합니다. 레지스터 레이아웃을 정의하는 구조체 정의를 구분하기 위해서는 'timer_reg_t'와 같이 고유한 이름으로 새로운 유형을 만든는 것이 중요합니다. 필요한 경우 이같은 유형을 사용하여 'timer_reg_shadow'같은 타이머 레지스터의 복사본을 만들 수 있습니다.

시행

각 빌드 전, 자동화 도구를 사용해 새 소스나 수정된 소스 코드를 검색하여 키워드 struct, union 또는 enum이 typedef 문이나 익명의 선언 내에서만 사용되는지 확인해야 합니다. 코드 검토시 새로운 형(type)에 대한 명명 규정을 시행해야 합니다.