After almost a week of work, finnaly we have decided what documentation style we will use in our JavaScipt code: JSDoc. We will follow the default reference here http://code.google.com/p/jsdoc-toolkit/wiki/TagReference
The default style that we will adopt must have:
- All files must have a header that show (at least) the tags @fileOverview, @author and @version.
- We need to try to comment everything, from classes and methods to properties and configs.
- The files where only interfaces are created (no implementation is made), the header documentation block is mandatory, altough the other blocks are optional.... read more