Emphasize Some Comments - but not Dirty the Code

Posted by Jon Sandness on Programmers See other posts from Programmers or by Jon Sandness
Published on 2011-03-15T19:52:11Z Indexed on 2011/03/16 0:18 UTC
Read the original article Hit count: 431

Filed under:

code-quality

|

comments

|

aesthetics

I'm having trouble structuring my comments at the moment.

I have major sections of the code that, when scrolling through the document, I want to be able to see those stand out.

Examples:

This is a normal comment:

int money = 100; //start out with 100 money

-

This is a comment to emphasize a certain part of the code:

/****** Set up all the money ******/

But I don't like that this isn't very clean. Is there a standard way of setting up this type of a comment?

© Programmers or respective owner

Related posts about code-quality

Tips on a tool to measure code quality?

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm looking for a tool that can provide code quality metrics. For instance it could report very long functions (spaghetti code) very complex classes (which could contain do-it-all code) ... While we're on the (subjective:-) subject of code quality, what other code metrics would you suggest? I'm… >>> More
Everyday Challenges to Improving Brownfield Code Quality

as seen on Code Project - Search for 'Code Project'
How best does one integrate code quality tools into an active project? >>> More
New Extension - Check ADF Code Quality

as seen on Oracle Technology Network - Search for 'Oracle Technology Network'
New free extension available from check for updates >>> More
Why is code quality not popular?

as seen on Stack Overflow - Search for 'Stack Overflow'
I like my code being in order, i.e. properly formatted, readable, designed, tested, checked for bugs, etc. In fact I am fanatic about it. (Maybe even more than fanatic...) But in my experience actions helping code quality are hardly implemented. (By code quality I mean the quality of the code you… >>> More
Counting Lines of code - quality metircs

as seen on Stack Overflow - Search for 'Stack Overflow'
I'm taking the lines of code for my Java project , the project contains lot of XML files too. Now my question is when calculating lines of code. Do i need to consider XML lines of code as well? Please help >>> 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