1.9.1 주석

주석의 주된 목적은 다음과 같이 프로그램 코드에서 명백하지 않은 부분을 이해하기 쉬운 말로 기술하기 위함이다.

// O(n log n)에 향균제를 탈바꿈한다.
while (cryptographic(trans_thingy) < end_of(whatever)) {
    ...

주석은 종종 난독화된 구현을 명확하게 해주는 의사 코드(pseudo-code) 역할을 한다.

// A = B * C
for (...) {
    int x78zy97 = yo6954fq, y89haf = q6843, ...
    for (...) {
        y89haf += ab6899(fa69f) + omygosh(fdab); ...
        for (...) {
            A(dyoa929, oa9978) += ...

위 코드의 경우 소프트웨어의 구조를 재구성할 수 있는지 물어봐야 한다. 이런 불명확한 구현은 라이브러리의 보이지 않는 부분에서만 사용하고 사용자가 사용할 때는 다음과 같이 의사 코드가 아닌 프로그램으로서 분명하고 간결한 코드를 사용해야 한다.

A = B * C;