Commenting practices?

Posted by Tarmon on Stack Overflow See other posts from Stack Overflow or by Tarmon
Published on 2010-05-03T17:48:25Z Indexed on 2010/05/03 17:58 UTC
Read the original article Hit count: 334

Filed under:

comments

|

comment

Hey Everyone,

As a student in computer engineering I have been pressured to type up very detailed comments for everything I do. I can see this being very useful for group projects or in the work place but when you work on your own projects do you spend as much time commenting?

As a personal project I am working on grows more and more complicated I sometimes feel as though I should be commenting more but I also feel as though it's a waste of time since I will probably be the only one working on it. Is it worth the time and cluttered code?

Thoughts?

© Stack Overflow or respective owner

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

Related posts about comment

Database Down error while posting a comment through comment box in facebook iframe application

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi, I have an iframe application. I have comment box functionality. It is displayed well but the problem comes when i click on post iam getting this error: Database Down Sorry, a temporary error has occurred. Please try again. How can i resolve this please help me on this? >>> More
I have a comment model, what to use in my mvc's? @comment, :comment or comment?

as seen on Stack Overflow - Search for 'Stack Overflow'
I have a comment model, I've seen examples of using @comment, :comment, comment to reference for the object in MVC? how do I know which is which? Is there a distinction? >>> More
Select Comment with xPath by Comment-Text

as seen on Stack Overflow - Search for 'Stack Overflow'
Hi How can I select the next node after an defined comment? I know the text of the comment and need the next nodes. Best regards Christoph >>> More
How would you organize a large complex web application (see basic example)?

as seen on Stack Overflow - Search for 'Stack Overflow'
How do you usually organize complex web applications that are extremely rich on the client side. I have created a contrived example to indicate the kind of mess it's easy to get into if things are not managed well for big apps. Feel free to modify/extend this example as you wish - http://jsfiddle… >>> More
How would you organize this Javascript?

as seen on Stack Overflow - Search for 'Stack Overflow'
How do you usually organize complex web applications that are extremely rich on the client side. I have created a contrived example to indicate the kind of mess it's easy to get into if things are not managed well for big apps. Feel free to modify/extend this example as you wish - http://jsfiddle… >>> More