Download
JSDoc 3 is an API documentation generator for JavaScript, similar to Javadoc or phpDocumentor. You add documentation comments directly to your source code, right alongside the code itself. The JSDoc tool will scan your source code and generate an HTML documentation website for you. JSDoc's purpose is to document the API of your JavaScript application or library. It is assumed that you will want to document things like modules, namespaces, classes, methods, method parameters, and so on. JSDoc comments should generally be placed immediately before the code being documented. Each comment must start with a /** sequence in order to be recognized by the JSDoc parser. Adding a description is simple, just type the description you want in the documentation comment. Once your code is commented, you can use the JSDoc 3 tool to generate an HTML website from your source files.
Features
- By default, JSDoc uses the built-in "default" template to turn the documentation into HTML
- Run the documentation generator on the command line
- JSDoc's purpose is to document the API of your JavaScript application
- JSDoc comments should generally be placed immediately before the code being documented
- Adding a description is simple
- More tags can be used to add more information
Project Samples
