이번 포스팅에서는 코딩 컨벤션에 대해 간단하게 정리해 보려고 합니다.

코딩 컨벤션

코딩 컨벤션(Coding convention)은 가독성 있는 코드를 작성하기 위한 공통의 코드 작성 가이드라인입니다.

주요 C++ 코딩 스타일 가이드

• ISOCPP Style Guide
• 구글 Style Guide
• PPP Style Guide

명명 규칙(Naming rule)

• 타입(클래스, 구조체, 타입 별칭, 열거형 등) 이름은 CamelCase 사용을 권장합니다.
• 변수와 함수 이름은 lower_snake_case 사용을 권장합니다.
• 상수 변수와 매크로 이름은 UPPER_SNAKE_CASE 사용을 권장합니다.
• Accessor의 경우 lowerCamelCase도 종종 사용합니다.

// Examples

class BoxInfo {
};

int box_volume;

const int BOX_LENGTH = 10;

int BoxInfo::getHeight() {
}

공백(Whitespace)

• 클래스 이름, 제어문과 중괄호 사이에는 공백 삽입을 권장합니다.
• 함수 이름과 소괄호 사이에는 공백 제거를 권장합니다.
• 제어문과 소괄호 사이에는 공백 삽입을 권장합니다.

// Examples

class BoxInfo {

public:

	void function() {
    
    	for (...) {
        }
        
    }
};

빈 줄(Vertical whitespace)

• 함수, 클래스 정의가 끝난 뒤 빈 줄 삽입을 권장합니다.
• 제어문이 끝난 뒤 빈 줄 삽입을 권장합니다.

// Examples

class BoxInfo {

public:

	void function();
    
};

void BoxInfo::function() {
	
    if (...) {
    }
    
}

기타

• 들여 쓰기는 Tap 또는 space 4개를 사용합니다.
• 변수는 선언과 동시 초기화를 권장합니다.
• 전역 변수 사용은 지양합니다.
• 상수의 경우 상수 변수 선언 후 사용을 권장합니다.
• 제어문의 경우 한 줄 제어문이라도 중괄호 삽입을 권장합니다.

포스팅을 마치며

이번에는 C++ 코딩 컨벤션에 대해 간단히 정리해 봤습니다.
C++을 처음 배울 때 기억을 떠올리면서 복습해 보는 시간이었습니다.

Reference

• 황선규. C++ 어서와! 자료 구조와 알고리즘은 처음이지?. programmers.
• Bjarne Stroustrup. Herb Sutter. C++ Core Guidelines. isocpp github pages.
• Google. Google C++ Style Guide. google github pages.
• Bjarne Stroustrup. PPP Style Guide. stroustrup.com.