Skip to content

Latest commit

 

History

History
77 lines (62 loc) · 1.69 KB

README.CODING.STYLE.md

File metadata and controls

77 lines (62 loc) · 1.69 KB

Coding Style

  • github에 소스를 커밋 할 시 반드시 컴파일을 성공한 결과만 넣어야 합니다.

  • 소스 커밋 시 최대한 로그를 자세히 달아놓아야 합니다.

  • 코드 주석 작성 방법

주석이 한 줄인 경우 
	
	// [주석] 

주석이 두 줄 이상인 경우

	/* [내용]
	*  ...
	*  ...
	*/

함수인 경우

	/*[함수에 대한 대략적인 설명]
	* [추가로 다음 설명]
	*
	* [인자값1] [설명]
	* [인자값2] [설명]
	* [리턴값]  [설명]
	*/
  • 이 소스에는 컨벤션이 있습니다. 컨벤션을 맞춰서 작성되었으니 참고 바랍니다.
1. if, switch, while, for는 {을 같은 행에 사용합니다. 
	if(...){
		int a;
		...
	}
	
2. 클래스는 '{'을 다음 행에 사용합니다. 
	Class A
	{
		...
	}

3. 클래스는 반드시 대문자로 시작하고,
	구조체는 반드시 '_'를 붙여야 합니다.
	상수계열 변수는 모두 대문자로 표기합니다.
	
4. 멤버변수는 반드시 m_로 시작합니다.
	클래스 내부 함수를 같은 클래스 안에서 쓸 때는 this->를 반드시 명시합니다.
	Class A
	{
		int m_a;
		void func();
		void func2(){
			m_a = x;
			this->func();
		}	
	}

5. 전역변수는 반드시 g_로 시작합니다. 
	static int g_a = 100;

6. 모든 변수와 함수는 중간에 '_'를 붙여 단어와 단어 사이를 구분합니다. 반드시 모두 소문자로 표기합니다. 
	void get_mac_address();

7. 모든 변수와 함수는 네이밍을 할시 아래와 같이 명시합니다. 
	확장 결과 값 => result_ext

8. 들여쓰기는 탭을 사용합니다.
	void func(){
		for( ; ; ;){
			...
			...
		}
	}