Login | Register   
LinkedIn
Google+
Twitter
RSS Feed
Download our iPhone app
TODAY'S HEADLINES  |   ARTICLE ARCHIVE  |   FORUMS  |   TIP BANK
Browse DevX
Sign up for e-mail newsletters from DevX


Tip of the Day
Home » Tip Bank » C++
Language: C++
Expertise: All
Jul 1, 1998

Don't forget to update comments whenever code is changed

There's only one thing worse than a non documented source file: a misleadingly documented source file. A detailed description of a member function which no longer exists, or a documentation of a default constructor which now appears to be taking 3 mysterious arguments, can turn software maintenance into a nightmare. So whenever you change your code or re-edit a machine-generated source file, don't forget to update the comments appropriately.
Danny Kalev
 
Comment and Contribute

 

 

 

 

 


(Maximum characters: 1200). You have 1200 characters left.

 

 

Sitemap
Thanks for your registration, follow us on our social networks to keep up-to-date