Commenting Code

Fine article about good and bad comments in the code Write Sweet-Smelling Comments. Some examples when comments are helpful:

– Comment at the top of the class about class purpose
– Commenting assumptions, limitations and decisions
– ToDo and policy description
– Description of algorithm

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s