24 Nov
2003
24 Nov
'03
6:12 p.m.
Bryce Harrington wrote:
The two asterisks starting the comment are what clues it in that it's a comment. Technically the first line isn't needed since the function name and params automatically get picked up.
That's also the norm in the Java world with Javadoc.
Start a comment with two asterisks "/**" and then space or newline. Next have a single sentence summary of the class or method, terminated with a period and then a space or a newline. Follow with a more detailed description. close the comment.
I definitely recommend against including the function name and args, since classically that's a major point to get out of sync with the code, so it's best left to autodetection.