0
I Use This!
Inactive

News

Analyzed about 4 hours ago. based on code collected about 7 hours ago.
Posted about 12 years ago by Eduardo
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 ... [More] adopt must have: * All files must have a header that show (at least) the tags [@fileOverview](http://code.google.com/p/jsdoc-toolkit/wiki/TagFileOverview), [@author](http://code.google.com/p/jsdoc-toolkit/wiki/TagAuthor) and [@version](http://code.google.com/p/jsdoc-toolkit/wiki/TagVersion). * 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. That's all. Let's code! [Less]
Posted about 12 years ago by Eduardo
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 ... [More] will adopt must have: * All files must have a header that show (at least) the tags [@fileOverview](http://code.google.com/p/jsdoc-toolkit/wiki/TagFileOverview), [@author](http://code.google.com/p/jsdoc-toolkit/wiki/TagAuthor) and [@version](http://code.google.com/p/jsdoc-toolkit/wiki/TagVersion). * 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. That's all. Let's code! [Less]