Coding Comment Styles C++, C, Java

[trippy1976]

Wondering from the programmers out there - what's your preferred commenting style? I like to call out portions of code using comments and have been using something along the lines of:

//----------------------------
// A comment.
// Line two
//----------------------------

I don't particularly care for this as it's hard to add text to line one and get it to stay in bounds of the dashes and look 'neat'. I tried

/*--------------------*\
A comment
\*--------------------*/

As an alternative, but I still don't like it. Thought others might have opinions.

 

[notfred]

/* comment until I get to the end
of the damn comment */

or:

// Short comment.

 

[safoo]

//i always comment like this
//im just used to it since high school. i never cared for using '/*'

 

[notfred]

# actaully, I usually
# make my comments like
# this

 

[MustPost]

// use this style

/*use this only when temporarily removing something from a "for" statesment*/

 

[Kilrsat]

//This is an example of my typical java comment for the sake of clarifying a line

/**
* Sometimes it looks like this, but
* This is mainly reserved for class/function
* headings
**/

#This is an example of my typical SAL comment
#Since I end up putting one of these on virtually every line
#Archaic languages are no fun, really

 

[Descartes]

Evil commenting styles:

/************************
* *
* EVIL! *
* *
* *
************************/

and...

int var; // trying
int var2; // to
int var3; // keep
int var4; // these lined up makes this evil too!

I actually don't mind...

/*
** This for method comments
**
**
**/

Comments in C# for XML documentation...

/// <summary>
/// Great way to document
/// </summary>

That's just a sample, there are a slew of available tags one can use in their comments for XML documentation in C#.

And for Java to generate documentation from Javadoc, it looks pretty familiar.

/**
* Some description.
* @param (someparam) somedescription
* @return (description of return value
*/

For C or C++ I have my own style format that I use to extract pertinent information from the source files. Just don't get too carried away with your commenting style. Succinctness is the key here, not verboseness.

[edit]It hosed my formatting, I forgot, sorry.[/edit]

 

[Alex]

i only know VB

'so therefore
'this is the only
'way to comment
'damn single speachmark thingies!

 

[Pakaderm]

I don't use comments. The code was hard to write, it should be hard to read too.

-Pak

 

[trippy1976]

<< I don't use comments. The code was hard to write, it should be hard to read too.

-Pak >>



Chuckle

 

[yoda291]

<< I don't use comments. The code was hard to write, it should be hard to read too.

-Pak >>



ur jokin right?

I use // and only // for comments. That way, I can use /* for debugging

 

[her209]

// I # Like /* My */ Comments ! Like REM This <!-- -->

 

[wolfsblood]

// I usually just use this one.

 

[tweakmm]

HA!
Commenting is for pansies...

 

[Theslowone]

I don' t comment, I write in binary.

 

[calpha]

I only comment on the comments that are outdated since I've been a fireman my whole life.

 

[Noirish]

i try to comment, but i usually forget.
when it's crunch time and i have to deliver my stuff, i usually don't comment.

however

/**
* this is good
*/

/*
this is good for commenting out useless codes assuming your ide auto indent for you
*/

// this is for one liner

 

[spamsk8r]

<< I don't use comments. The code was hard to write, it should be hard to read too.

-Pak >>



Darn tootin, I don't want other people messing with my stuff anyway