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.

Share the Post:
Share on facebook
Share on twitter
Share on linkedin


Recent Articles: