What is the right level of granularity for code commenting?

Posted by Nick on Programmers See other posts from Programmers or by Nick
Published on 2011-06-22T01:20:05Z Indexed on 2011/06/22 8:30 UTC
Read the original article Hit count: 286

Filed under:

code

|

comments

Commenting in code I believe is very important but recently I've been reviewing code that has left me wondering particular this one.

 //due to lack of confidence with web programming leaving this note in for now

What is the right level of granularity for code commenting?

EDIT: Obviously the above comment is shocking hence why I'm asking the question. I've recently noticed the inline comments in the code at my work place annoying. Instead of getting angry I want discovery the acceptable level of granularity for code commenting in the community.

© Programmers or respective owner

Related posts about code

Soapi.CS : A fully relational fluent .NET Stack Exchange API client library

as seen on Stackapps - Search for 'Stackapps'
Soapi.CS for .Net / Silverlight / Windows Phone 7 / Mono as easy as breathing...: var context = new ApiContext(apiKey).Initialize(false); Question thisPost = context.Official .StackApps .Questions.ById(386) .WithComments(true) .First(); Console.WriteLine(thisPost.Title); thisPost … >>> More
Super Joybox 5 HID 0925:8884 not recognized as joystick in Ubuntu 12.04 LTS

as seen on Ask Ubuntu - Search for 'Ask Ubuntu'
Problem: When using the "Super JoyBox 5" 4 port playstation 2 to USB adapter, the device is not recognized as a joystick. there is no js0 created, but instead another input eventX and mouseX are created in /dev/input. When using the directional buttons (up down left right) on a Playstation 1 controller… >>> More
Code Golf: Code 39 Bar Code

as seen on Stack Overflow - Search for 'Stack Overflow'
The challenge The shortest code by character count to draw an ASCII representation of a Code 39 bar code. Wikipedia article about Code 39: http://en.wikipedia.org/wiki/Code_39 Input The input will be a string of legal characters for Code 39 bar codes. This means 43 characters are valid: 0-9… >>> More
VS 2012 Code Review – Before Check In OR After Check In?

as seen on Geeks with Blogs - Search for 'Geeks with Blogs'
“Is Code Review Important and Effective?” There is a consensus across the industry that code review is an effective and practical way to collar code inconsistency and possible defects early in the software development life cycle. Among others some of the advantages of code reviews are, Bugs… >>> More
Colorize code inside <code></code>

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm looking for a open source PHP script to colorize the code inside <code></code> or [code][/code] tags. Thanks >>> 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