Preferred Editor(s) (176)

85 Name: #!/usr/bin/anonymous : 2008-08-05 04:54 ID:njBRasrM

>>83

Structured comments make it easier to automatically extract information from comments; it does not make it easier to add information.

Comments are so limited, you cannot put meaningful documentation inside them, and by enforcing a rigid structure you are encouraging poor documentation, and making it impossible to write good documentation.

Generally speaking, I find that if a function parameter isn't apparent from the code or its name (prototype, minidoc, etc), then the API is probably stupid and was written by an idiot. I have never seen those situations saved by documentation.

Name: Link:
Leave these fields empty (spam trap):
More options...
Verification: