Linux, programming, computers and life

September 26, 2007

commenting code

Filed under: programming

I think i found out how to decide whether the code is well commented. I even know how to make it so. The recipe is simple - finish some task, do not touch and/or think about it for a week or two (you better do something else in the meanwhile - otherwise you’ll be probably fired ;) ). Now read the code (i assume you forgot it a little at least) and add comments anywhere you need to think “what’s going on here???”… Also remove comments which are absolutely redundant, but be careful here - you can still remember the code and it’s you who wrote it in the first place.

Technorati Tags: , , ,

Get free blog up and running in minutes with Blogsome
Theme designed by Gary Rogers