Open Krxtopher opened 11 years ago
There's a 4th type too /*!
for licensing of libraries
Should we also add a standard that developers should use Java Doc syntax for commenting?
I like that suggestion. You could just link to their how-to page
I am not extremely familiar with the differences in autodoc syntax.
For JavaScript, what should we recommend? Javadoc, JSdoc, YUIdoc?
Unless we're ready to standardize on an auto doc tool I don't think that we have to endorse a specific syntax in this general standards document. Regardless of which doc comment syntax is used on a project, they almost all use the double star convention to denote a doc comment.
Should we wait to include the doc comment example until the syntax is standardized?
Yes, let's hold on that and revisit at a later time
I think we should call out 3 types of comments:
This is consistent with how many editors and IDEs classify comments and more closely matches how developers should think about comments (IMHO).
Doc comment example:
Multi-line comment example:
Single-line comment example: