code comments made easy

January 23, 2006

in Uncategorized

Here’s a solution to those incredibly tedious code comments. Click a few buttons, move a few sliders, and The Commentator automatically generates comments for you.

Personally I think all my code comments follow the conventions in the last example of that page:

(verbosity=3, relevance=0, religous references on)

int sum = 0;
//goddamit I need some freaking coffee
for (int i= 0; i < a.length; i++) {
sum += a[i];
}

(I can't remember where I got this)

{ 2 comments }

1 Aristotle Pagaltzis January 24, 2006 at 5:07 am

strat:

At university, a professor once told us also to comment when, why and in what mood we wrote some code, e.g

# 11.11.2004, late night
# replaced global filehandles with lexical ones
# after having drunk eight beers

That mood thing is actually a good idea.

2 Karl Elvis January 30, 2006 at 5:31 pm

I’m just tryin’ to figure out if that’s a joke or if you can really download it. B^)

Comments on this entry are closed.

Previous post:

Next post: