Thread: Comments

Depends - if I'm just making a program to test something, I don't comment. If I'm planing to give it out to someone, I will comment some parts. I like doing this:

Code:

/****************************
Function name
Function description
****************************/
ret functionname() {}

I use them both, depending on what they do best:

Code:

// Bla bla bla (only need one line)

Code:

/*bla
 *bla bla
 *bla bla
 *bla (need several lines)
 */

- SirCrono6

it depends... look at this piece of code:

Code:

...			if(p2.hp>0)	//if player two survives
				turn=2;	//time for player two to attack
			else	//if player two dies
				turn=0;	//no more attacking
		}
		if(turn==2)	//player two's turn
		{
			atkdam=p2.atk*static_cast<double>((1+rand()%100)/100.0);
			atkdam+=p2.spd*static_cast<double>((1+rand()%25)/100.0);
			defdam=p1.def*static_cast<double>((1+rand()%75)/100.0);
			defdam=p1.spd*static_cast<double>((1+rand()%25)/100.0);

			/*	
			How things are watered down:
				atk==100%
				def==50%
				spd==12%
			*/
...

I do the C-style comments (/**/) for header information and multi line things... and sometimes in classes to sepreate functions. I use C++ comments (//) for single line things... sometimes I use a mix (not really) like this:

Code:

//*********************************************//
//               Title Of Section              //
//*********************************************//

If I use C-style at all, I use it in the javadoc fashion, e.g.

Code:

/** This function does nothing.
 * @param x a useless parameter
 * @return 5
 */
int donothing(int x) {
  return 5;
}

I prefer frame-like comments for function headers n such. They are visible enough to easily find the functions when searching the file but still doesn't make it messy like * do (IMO). I believe this is LISP style.

Code:

//+---------------------------
//| Yada yada
//+---------------------------
int f()
{
  return 0;
}

For normal comments a simple // does the job.

Code:

// Yada yada
int x = f();

also *sometimes* i use the c-style comments for documentation at the top of the program for my teacher (he's strict about having a plan )