Dr. Dobb's is part of the Informa Tech Division of Informa PLC

This site is operated by a business or businesses owned by Informa PLC and all copyright resides with them. Informa PLC's registered office is 5 Howick Place, London SW1P 1WG. Registered in England and Wales. Number 8860726.

Channels ▼

Community Voices

Dr. Dobb's Bloggers

When do i clean my code?

February 19, 2010

This has been really a great problem for me to decide on when should i clean my code. And i even go the extent of thinking if the project/product should still have a clean code. We, the developers, add all sorts of comments into the code while implementation. Now, the comments become too valuable to get rid of. And i even think of adding a one liner for each statement. I am a lazy programmer and sometimes tend to forget what a particular piece of code does(written by me, ofcourse). However, i am too scared to remove my comments. Paradoxical, yet true. What level of commenting is needed after all? Should the comments be terse enough for only my understanding? or should i double up the comments relative to the KLOC? And if i have added something for my reference, exclusively, should it be really there in the final product?  What really made me think was cleaning the code for a demo ready product and be prepared to fix bugs that will crop up during the demo. So where do my valuable comments go? The commented echo/print/return/die statements that i had added before code cleaning are gone only to find them get added later during bug fixing. Sigh! How do you guys clean the mess?  

Related Reading

More Insights

Currently we allow the following HTML tags in comments:

Single tags

These tags can be used alone and don't need an ending tag.

<br> Defines a single line break

<hr> Defines a horizontal line

Matching tags

These require an ending tag - e.g. <i>italic text</i>

<a> Defines an anchor

<b> Defines bold text

<big> Defines big text

<blockquote> Defines a long quotation

<caption> Defines a table caption

<cite> Defines a citation

<code> Defines computer code text

<em> Defines emphasized text

<fieldset> Defines a border around elements in a form

<h1> This is heading 1

<h2> This is heading 2

<h3> This is heading 3

<h4> This is heading 4

<h5> This is heading 5

<h6> This is heading 6

<i> Defines italic text

<p> Defines a paragraph

<pre> Defines preformatted text

<q> Defines a short quotation

<samp> Defines sample computer code text

<small> Defines small text

<span> Defines a section in a document

<s> Defines strikethrough text

<strike> Defines strikethrough text

<strong> Defines strong text

<sub> Defines subscripted text

<sup> Defines superscripted text

<u> Defines underlined text

Dr. Dobb's encourages readers to engage in spirited, healthy debate, including taking us to task. However, Dr. Dobb's moderates all comments posted to our site, and reserves the right to modify or remove any content that it determines to be derogatory, offensive, inflammatory, vulgar, irrelevant/off-topic, racist or obvious marketing or spam. Dr. Dobb's further reserves the right to disable the profile of any commenter participating in said activities.

Disqus Tips To upload an avatar photo, first complete your Disqus profile. | View the list of supported HTML tags you can use to style comments. | Please read our commenting policy.