Chap6. 명확하고 간결한 주석 달기

1
2
3
4
5
6
7
8

// The int is the CategoryType.
// The first float in the inner pair is the 'score',
// the second is the 'weight'.
typedef hash_map<int, pair<float, float> > ScoreMap;

/* CONCISE ONE!!! */
// CategoryType -> (score, weight)
typedef hash_map<int, pair<float, float> > ScoreMap;

1
2

// Count how many newline bytes ('\n') are in the file.
int CountLines(string filename) { ... }

1
2
3

// ...
// Example: Partition([8 5 9 8 2], 8) might result in [5 2 | 8 9 8] and return 1
int Partition(vector<int>* v, int pivot);

1
2
3
4
5
6
7
8

As another example, a comment such as:
// Remove excess whitespace from the street address, and do lots of other cleanup
// like turn "Avenue" into "Ave." This way, if there are two different street addresses
// that are typed in slightly differently, they will have the same cleaned-up version and
// we can detect that these are equal.

could instead be:
// Canonicalize the street address (remove extra spaces, "Avenue" -> "Ave.", etc.)