[masoug]

I don't know about anyone else, but I like to keep my comments in code nice and consistent. Call me a nerd, but somehow I like to have comments with periods and capitalization in the right place. I wonder if anyone else tends to do this?

-Masoug

[Atli]

** Moved to Software Development **

[sepp2k]

No, I don't use English grammar in my comments - I use Yoda speak:

// Print a string to the screen this method will. Not call it with a null argument you shall.

[masoug]

sepp2k, on 13 May 2012 - 04:08 AM, said:

No, I don't use English grammar in my comments - I use Yoda speak:

// Print a string to the screen this method will. Not call it with a null argument you shall.

"May the source be with you."

[cfoley]

I prefer to use comments to improve the grammar of my code.

		/*Define an*/ int/*eger variable to be used as the*/ counter/*.*/;
		/*Set the*/ counter = 0/*.*/;
		
		/*Repeat*/ while /*the*/(counter <= 10)/*.*/ {
			/*Calculate the*/ int/*egral*/ answer /*as*/ = 2 * counter/*.*/;
			/*With the default*/ System. out/*put stream, */.print( /*a formatted*/	String. /*with the*/ format("2 x %d = %d\n", /*substituting the*/ counter, /*and*/ answer))/*.*/;
			/*Update the*/ counter /*making it*/ = counter + 1/*.*/;
		}
		/*Make sure the default*/ System. out/*put stream is */ .flush()/*ed.*/;

[sepp2k]

Haha, that's awesome. Literate programming 2.0.

[fromTheSprawl]

Yes, it's a must. Especially if you're working with complex computations and multiple methods that almost look the same with each other. Or lose your sanity. Your choice.

[turboscrew]

cfoley, on 18 May 2012 - 02:31 AM, said:

I prefer to use comments to improve the grammar of my code.

		/*Define an*/ int/*eger variable to be used as the*/ counter/*.*/;
		/*Set the*/ counter = 0/*.*/;
		
		/*Repeat*/ while /*the*/(counter <= 10)/*.*/ {
			/*Calculate the*/ int/*egral*/ answer /*as*/ = 2 * counter/*.*/;
			/*With the default*/ System. out/*put stream, */.print( /*a formatted*/	String. /*with the*/ format("2 x %d = %d\n", /*substituting the*/ counter, /*and*/ answer))/*.*/;
			/*Update the*/ counter /*making it*/ = counter + 1/*.*/;
		}
		/*Make sure the default*/ System. out/*put stream is */ .flush()/*ed.*/;

COBOL reinvented?

I tend to use both full sentences, but also "spoken language" and other notations.

/* Positive? */
if (x < 0)
{
  /* No can do */
  print_error();
}

[ankurwase]

Speaking Language

[anonymouscodder]

Of course. This poll is kinda stupid.