code comments made easy

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 thoughts on “code comments made easy

  1. 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.

Comments are closed.