Comment 작성 요령

/* 잘못된 comment는 없는 것보다 못하다 */

 

// How가 아니라 Why를 기술하라

# 코드를 묘사하지 마라

; 특이사항은 반드시 comment로 남겨라

  - 예를 들어 운영체제 문제로 대충 처리한 코드 등

/* 진실을 말하라 */

* 가치있게, 명료하게, 알기 쉽게 만들어라

* 코드가 수정되면 comment도 수정해야 한다

 

Comment 종류

 

블록 코멘트

/*

 * 눈에 쉽게 들어오는

 * 블록 코멘트

 */

 

들여쓰기

void function()

{

    for (int i = 0; i < ASDF; iI++)

    {

// 개인적으로 이런 코멘트는

        do_something(i);

// 보기 어려워 선호하지 않는다

        another(i);

    }

}

 

행 끝 코멘트

void function()

{

    for (int i = 0; i < ASDF; iI++)

    {

        do_something(i);                // 행 끝 코멘트는 

        another(i);                        // 코드로부터 분리해 잘 보이게 하라

    }

}

 

방파제 코멘트

/*******************************************************************************

* 방파제는 눈에 확 들어오지

* 주로 header나 function define에 사용

*******************************************************************************/