Hey, if I have to document the code I might as well have some fun with it, right?
You'll find I also tend to write funnier comments when I'm frustrated, like the "HERE BE DRAGONS" ones I have at the top of a few particularly hairy functions. Then you have my personal favorite minisphere comment of all time, in persons.c:
// check that the person didn't mysteriously disappear...
if (!does_person_exist(person))
return; // they probably got eaten by a hunger-pig or something.
And of course, this one's a classic too:
// check for obstructing persons
if (!person->ignore_all_persons) {
for (i = 0; i < s_num_persons; ++i) {
if (s_persons[i] == person) // these persons aren't going to obstruct themselves!
continue;
if (s_persons[i]->layer != layer) continue; // ignore persons not on the same layer
if (is_person_following(s_persons[i], person)) continue; // ignore own followers
if (is_person_ignored(person, s_persons[i])) continue;
base = get_person_base(s_persons[i]);
if (do_rects_intersect(my_base, base)) {
is_obstructed = true;
if (out_obstructing_person) *out_obstructing_person = s_persons[i];
break;
}
}
}