Comment

Comment by mmastrac

I've started giving these instructions and I think I've been much more successful in generating clear output:

Comment blocks are <= 7 words, function names <= 4 words. User-facing message strings should be <= 10 words. Use an active voice, no stage performances, and pick the most common word when choosing among alternatives.

Limiting the number of words is the strongest factor in cleaning up the output, IMO.

For older code I've instructed it to delete all the comments, and then I re-comment it using a new session and these guidelines, asking it to rejustify the need for every comment to itself.

parent mmastrac 2 months ago

Discussion

Live from the official Hacker News API

A modern reader for Hacker News · SvelteKit + Skeleton