Tuesday, July 31, 2007

Create useful and relevant JavaScript documentation with JSDoc


Whatever the reason, not documenting an application is never a good thing, even if it is usually something of a chore. This is especially true when given the task of documenting client-side JavaScript. There is a really neat tool for Java developers that aids in the generation of documentation called Javadoc. There is also a version for JavaScript called JSDoc, which is used to develop HTML documentation that not only fulfills the need for code documentation but also helps to prevent problems such as multiple functions or objects that essentially do the same thing and the general lack of knowledge of what is in the library. This tutorial shows you how to install and use JSDoc.

here u can see the pdf of how to install and use JSDoc

No comments: