code description

[ceanth]

Hi there, could someone give me some tips for writing code descriptions, by that i mean the top part of the code where u use lots of // to write some text to the reader, i would like some tips or even an example to make the coding look professional.

many thanks

ceanth

[brendandonhue]

Describe each variable that the user may want to customize, and give an example value.

Give a comment on what IF statements are doing...
//Check if the user has done this....

and tell them how they can modify the script
//If you don't want to remove formatting-delete the next 2 lines.

[PeOfEo]

'this is a comment in vb

<!-- this is one in html -->

// this is one in java script

/* This is a
multi line comment
in java script */