나의 코딩 규약

이름 짓기

재정의된 외부 기본 변수형

첫 문자가 밑줄이고 다른 문자들은 소문자나 밑줄이다. 예를 들어,

typedef short _integer2; /* 2 바이트 부호 있는 정수 */

외부 구조체

첫 문자가 'tag'를 의미하는 밑줄이고, 다른 문자들은 밑줄이 없는 낙타 표기법을 사용한다. 예를 들어,

struct _IOTextLocation {
	...;
};

그리고 구조체 자신에 대한 typedef 는 사용하지 않는다. 경우에 따라 구조체 포인터에 대한 typedef 는 사용한다.

내부 구조체

첫 문자는 'tag' 를 의미하는 밑줄이고, 다른 문자들은 소문자나 밑줄이다. 예를 들어

struct _mem_debug {
	...;
};

외부 정의

이 규칙은 외부 매크로나 열거 상수들에 적용된다. 대문자와 밑줄이 사용되지만, 첫 문자는 밑줄이 아니다. 예를 들어,

#define IO_END 0

내부 정의

이 규칙은 내부 매크로나 열거 상수들에 적용된다. 대문자와 밑줄이 사용되고, 첫 문자는 밑줄이다. 예를 들어,

#define _IO_DEFAULT_BUFFER 512

외부 함수

함수 속성을 나타내는 소문자들로 시작하고 다른 문자들은 밑줄이 없는 낙타 표기법을 사용한다. 예를 들어,

int ioReadHierarchy( struct _IOContext* io, char** excl, int nexcl, char** current_key );

내부 함수

소문자들과 밑줄을 사용한다. 예를 들어,

void* mem_alloc( long size );

지역 변수

소문자와 밑줄을 사용하며 가능하면 간단하고 짧은 이름을 갖는다. 예를 들면,

int i, count /* 또는 cnt */; /* an index and counter */
void* context /* 또는 ctx */; /* a context */

전역 변수

소문자와 밑줄들을 사용하고 이름은 명확히 이해될 수 있어야 한다. 접두어로 속성 명칭을 사용하는 것이 좋다. 예를 들어,

int dl_init_count; /* 동적 적재기 함수에 대한 초기화 계수기 */

소스 파일 형식

들여 쓰기

탭은 4 문자이다.

블럭

K&R 형식을 따른다.

함수를 구현할 때 이름 표기

GNU 형식이 사용된다. 예를 들어,

void
iotextRead

정규 표현식 '^iotextRead' 이 함수가 구현된 곳으로 커서를 옮겨줄 것이다.

호환성을 위한 정의

소스 호환성을 유지하기 위해 몇가지 매크로가 coral/compat.h 에 정의되어 있고, 주요 정의가 여기에 소개된다. 나는 이 정의들을 최대의 소스 호환성을 필요로 하는 내 라이브러리 내에서 사용한다.

원거리 및 거대 포인터

원거리 및 거대 포인터는 16 비트 플랫폼의 구식 특징이지만, 나는 이들 플랫폼에 이식성을 유지하고 있다.
__F, 원거리 포인터 키워드
__H, 거대 포인터 키워드

예를 들어,

char __F* p; /* 원거리 포인터 */
char __H*__F* ph; /* 거대 포인터에 대한 원거리 포인터 */

함수 정의

적절한 유틸리티를 사용하여 소스 코드를 몇 부분으로 나누기 위해 __MODULEBEGIN__( "srcname" ) __MODULEEND__ 매크로를 사용한다. 에디터에서 '* function_name'을 찾음으로써 함수가 정의된 곳으로 이동하기 위해 함수 이름을 포함하는 주석문을 사용한다.

__MODULEBEGIN__( "mresize.c" )
/* memResize */

__MODULEEND__

함수 호출 규약

각 플랫폼에 대한 표준 호출 규약을 사용하기 위해 __API 매크로가 정의된다. 예를 들어,

void __API
doSomething

함수 인자

K&R 과 표준 형식을 모두 지원하기 위해 몇가지 매크로를 사용한다. 예륻 들어,


void __F* __API memResize P_A(( void __F* p, long size ));

void __F* __API
memResize
	P_B(( p, size ))
	P_1		void __F* p
	P_N		long size
	P_E
{
	...;
}

이전 | 대문 | 영어