smells-and-heuristics-environment.markdown

+###### [Home](home) / [Digitec Coding Practices](coding-practices) / [Global Coding Standards](global-coding-standards) / Smells and Heuristics - Environment
+
+---
+
+
+[:arrow_left: Comments](smells-and-heuristics-comments) | [Functions :arrow_right: ](smells-and-heuristics-functions)
+
+# Environment
+
+
+#### C1: Inappropriate Information
+
+It is inappropriate for a comment to hold information better held in a different kind of system such as your source code control system, your issue tracking system, or any other record-keeping system. Change histories, for example, just clutter up source files with volumes of historical and uninteresting text. In general, meta-data such as authors, last- modified-date, SPR number, and so on should not appear in comments. Comments should be reserved for technical notes about the code and design.
+
+
+
+
+---
+
+[:arrow_left: Comments](smells-and-heuristics-comments) | [Functions :arrow_right: ](smells-and-heuristics-functions)
\ No newline at end of file