프로그래밍

my naming convention

문달78 2013. 2. 28. 11:57

1. global 변수는 g_ 태그, static 변수는 s_ 태그, local 변수는 태그 없음.

2. 변수는 모두 소문자로 표시... g_lrf_offset은 LRF 모듈의 오프셋을 의미한다.

3. static 또는 private 함수는 doSomething 과 같이 소문자로 시작하여 다음 단어가 시작할 때 대문자로 연결한다.

4. global 또는 public 함수는 DoSomething 과 같이 대문자로 시작하여 다음 단어가 시작할 때 대문자로 연결한다.

5. #define 상수는 모두 대문자로 "#define LRF_MIN_DISTANCE 30"과 같이 써준다.

6. 파일명은 모듈의 기능을 가장 잘 설명하는 소문자로 함. ex) app.c, ui.c, uart.c

7. 함수명을 지을때 동사의 암묵적인 주어는 해당 함수를 실행하는 프로세서(또는 시스템)임을 고려한다.

 ex) MCU에서 raw 데이터를 PC로 전송하는 함수명은 GetRawData(PC가 주어)가 아닌 SendRawData(MCU가 주어)가 적절하다. Application 레이어에 있는 함수명의 주어는 사용자 또는 시스템이 되고 내장형 SW에서 하위 레이어에 있는 함수들의 주어는 프로세서 또는 하드웨어 단위의 개체가 된다.

 

 



'프로그래밍' 카테고리의 다른 글

프로그래머를 위한 폰트  (0) 2012.12.04
AVR RS-232 flash burning software  (0) 2012.11.13
De Brujin sequence(카드 맞추기 마술!!)  (0) 2012.10.29
조건문 없이 최대(최소)값 결정하기  (0) 2012.10.25
Amdahl's law  (0) 2012.10.25