코드 작성 규약

코드 작성 규약

프로젝트 코드 작성시 아래 규칙에 따라 작성합니다.

파일 네이밍

• 파일 이름은 영문자와 숫자의 조합으로 작성한다. (띄어쓰기는 쓰지 않는다.)
• 파일 이름은 name space와 class명의 조합으로 한다.

• 예)io_tcpSocket.cpp

네이밍

• camel-case를 따른다.

• 클래스, 구조체, 상수, 열거형의 이름은 첫 글자를 대문자로 쓴다.
• 예) MyFileClass
• 변수, 메소드의 이름은 첫 글자를 소문자로 쓴다.
• 예) sendBufferSize

• 매크로에는 대문자와 언더바만 사용한다.
• vector, array, list 등의 컨테이너의 인스턴스 이름 뒤에는 s를 붙인다.

• 예) vector monsters;

• 컨테이너의 수량을 나타내는 변수 앞에는 n을 붙인다.

• 예) int nWorkers;

키워드

• RTTI를 사용하지 않는다.
• virtual 대신 ABSTRACT와 OVERRIDE 매크로를 사용한다.
• using namespace를 쓰지 않는다.

헤더파일

• 모든 헤더 파일에는 pragma once를 한다.
• 가능한 한 전방선언을 사용한다.

클래스 정의

• 다중 상속을 사용하지 않는다.
• 소멸자는 가상 함수로 선언한다.
• public, protected, private 순서로 선언한다. method가 먼저 오고 property가 나중에 온다.(따로 정의한다.)

• 예)

public:
	void Func();
	void Func2();

	int var1,var2;
protected:
	void Func3();

	double var3,var4;

소스 코드

• 한 줄이 대략 80글자가 넘지 않도록 적절하게 줄바꿈을 한다.
• 파일의 맨 위에 파일 정보 및 작성자, 작성일자, 최종 수정자, 수정일자, 수정사유 등을 기록한다.

• 예)

//File1.h
//작성자 : 남현욱
//예시용 파일
//작성일자 : 2014.08.17
//최종 수정자 : 김연우
//수정일자 : 2014.08.19
//그냥 수정해봄