Are there standard formats for comments within code? [closed]

Answer 1

//Cheap Debugger

//Response.Write(MySQLStringBecauseINeedToKnowWhatsBroken);

Answer 2

You should really consider a couple things to make good comments beyond formatting.

1. Do not simply restate what the code is doing. For example,

 // Start the services
 StartServices();

is a frigging terrible comment!

2. Describe why. Why is the code doing what it's doing? What's the business assumption or algorithm step?

3. Format your comments for maximum readability. Tab them properly, leave spaces where necessary, etc.

4. If someone has already started commenting in a standard way, don't break that standard.

5. Check this article on MSDN about writing effective comments: http://msdn.microsoft.com/en-us/library/aa164797.aspx

Answer 3

I don't think there is a standard for what you are asking. And I don't see how it would add any benefit from /// comments on the method itself.

For creating documentation from your C# classes take a look at Sandcastle.

Answer 4

/**
 * block comments to document a method for javadoc go like this
 * @param
 * @return
 * @exception BTKException
 * @see BTK
 */

Answer 5

//For one line, I write them like this

/*
For multiple lines of text
I write them like this
*/

/*
for(multiple lines of code){
  I.WriteComents(With("//"));
  Reason==If(I.Remove('The top begin-quote mark') then
    I.Worry.Not('About removing the close-quote mark');
//*/

Answer 6

If you are paranoid and don't use or trust source control, you might do this

// Initials-YYMMDD-fixNo-Start
dosomething();
// Initials-YYMMDD-fixNo-Finish

It makes a bloody big mess, but it gives you some way to rollback changes.

But I'd suggest using source control