[ECCS] 일반 약어

1. 일반 규정

1.5 일반 약어

규정

1. 약어와 두문자어는 공학계에서 그 의미가 광범위하고 일관되게 이해되지 않는 한 일반적으로 피해야 합니다.
2. 프로젝트별 약어 및 두문자어 표는 버전 관리 문서에 표시되어야 합니다.

예시

Abbreviation	Meaning
adc	analog to digial converter
avg	average
b_	Boolean
buf	buffer
cfg	configuration
curr	current (item in a list)
dac	digital to analog converter
ee	EEPROM
err	error
g_	global
gpio	general purpose IO pins
h_	handle (to)
init	initialize
io	input / ouput
isr	interrupt serivce routine
lcd	liquid crystal display
led	light emitting diode
max	maximum
mbox	mailbox
mgr	manager
min	minimum
msec	millisecond
msg	message
next	next (item in a list)
nsec	nanosecond
num	number (of)
p_	pointer (to)
pp_	pointer to a pointer (to)
prev	previous (item in a list)
prio	priority
pwm	pulse width modulation
q	queue
reg	register
rx	receive
sem	semaphore
str	string (null terminated)
sync	synchronize
temp	temperature
tmp	temporary
tx	transmit
usec	microsecond

이유

프로그래머는 암호같은 약어와 두문자어를 코드에 너무 쉽게 사용합니다(심지어 이력서에까지도!). 프로그래머가 ZYZGXL의 의미를 안다고 해서 이후에 유지보수나 포팅 담당자가 이 암호같은 이름을 이해할 수 있는 것은 아닙니다.

시행

이 규정은 코드 검토시 시행되어야 합니다.