Do you have any tips for commenting code?

Posted by Rob Wells on Stack Overflow See other posts from Stack Overflow or by Rob Wells
Published on 2010-04-10T22:09:25Z Indexed on 2010/04/10 22:13 UTC
Read the original article Hit count: 391

Filed under:

Development

|

comments

|

programming

G'day,

I've read both of Steve McConnell's excellent Code Complete books "Code Complete" and "Code Complete 2" and was wondering if people have any other suggestions for commenting code.co

My commenting mantra could be summed up by the basic idea of expressing "what the code below cannot say".

While enjoying this interesting blog post by Jeff about commenting I was still left wondering "When coding, when do you feel a comment is required?"

© Stack Overflow or respective owner

Related posts about Development

How to resolve: 'cmd' is not recognized as an internal or external command?

as seen on Stack Overflow - Search for 'Stack Overflow'
I have searched other forums to solve this error where it would either end with: 1.) re-install OS 2.) Setting path variable C:/Windows/System32 The latter did not work, and as you can probably imagine, I do not want to have to re-install my OS... I am running the command "mvn jetty:run" and the… >>> More
PHP Web Development, Web Development Using PHP As an Open Source

as seen on Ezine Articles - Search for 'Ezine Articles'
PHP is a widely-used general-purpose scripting language that is especially suited for web development and can be embedded into HTML. PHP is the most famous language nowadays as it is an open source and web development requires no costs in implementation. >>> More
Small Business Web Site Development - 3 Tips For Getting Business Web Development

as seen on Ezine Articles - Search for 'Ezine Articles'
If your want to grow your Small Business, Web Site Development is a crucial ingredient for this new growth going forward. Web development is more than putting words or content on a web page. Today more than 50% of folks looking for products or services use the internet to find what they needs. Here… >>> More
Surface development: it’s just like software development

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
Surface is magic. Everyone using it seems to think that way. And I have to be honest, after working for almost 2 years with the platform I still get that special feeling the moment I turn on the unit to do some more work. The whole user experience, the rich environment of the SDK, the touch, even… >>> More
Desktop development versus Web development

as seen on Stack Overflow - Search for 'Stack Overflow'
What are the advantages and disadvantages of one model and the other? Why and when would you choose one or the other? If you were going to build a business application, which is the best approach for you? To make this a fair question, is better if you post only quantified non-subjective answers. >>> More

Related posts about comments

SQL Developer Data Modeler: On Notes, Comments, and Comments in RDBMS

as seen on Oracle Blogs - Search for 'Oracle Blogs'
Ah the beautiful data model. They say a picture is worth a 1,000 words. And then we have our diagrams, how many words are they worth? Our friends from the Human Relations sample schema So our models describe how the data ‘works’ – whether that be at a logical-business level, or a… >>> More
Comments on Comments

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
I almost tweeted a reply to Capar Kleijne's question about comments on Twitter, but realized that my opinion exceeded 140 characters. The following is based upon my experience with extremes and approaches that I find useful in code comments. There are a couple extremes that I've seen and reasons… >>> More
Comments in string and strings in comments

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi there, I am trying to count characters in comments included in C code using Python and Regex, but no success. I can erase strings first to get rid of comments in strings, but this will erase string in comments too and result will be bad ofc. Is there any chance to ask by using regex to not match… >>> More
checkins/recent not returning comments or even counts of comments

as seen on Stack Overflow - Search for 'Stack Overflow'
My application has been using the checkins/recent endpoint to show where all the current users friends are currently at and I had included a button the user could press to comment on a checkin. The button used to have the comment count on it until recently. It seems the checkins/recent endpoint no… >>> More
VS for Database Pros (GDR R2) Removes Sproc Comments (2 replies)

as seen on .NET 247 - Search for '.NET 247'
I have been working with my team to implement Data Dude GDR R2 for managing ALL of the databases for our applications. So far I am very pleased by what we can do with the tool with a single exception. I want to have a header with comments as part of every stored procedure so we can track the history… >>> More