[Code Review] 2. 주석은 대문자로 시작해서 마침표로 끝낸다.

때때로, 리뷰어는 코드에 주석을 추가할 것을 요구하기도 한다. 이럴 때, 가끔 하는 실수가 소문자로 문장을 시작하거나 마침표를 빼먹는 경우이다.

    // to disable logging notImplemented set the DISABLE_NI_WARNING
    // environment variable to 1
    LogNotYetImplemented.state = WTFLogChannelOn;

항상 주석은 대문자로 시작해서 반드시 마침표로 끝내도록 하자.

    // To disable logging notImplemented set the DISABLE_NI_WARNING
    // environment variable to 1.
    LogNotYetImplemented.state = WTFLogChannelOn;

소스 코드와 마찬가지로 주석의 폭도 소스코드의 컬럼(column)수에 맞게 제한해야 한다. 예를 들어, Chromium Project의 경우 80 컬럼으로 제한하고 있다.

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s