Getting started with jsdoc

Getting started with jsdoc

Java introduces a tool named javadoc. This tool can be based onSource codeGenerate API documentation in HTML format. The generated HTML document can be read in any web browser, and can be published online because it is generated in HTML format, so that developers can easily access these documents. API documentation should be provided in a format that can be easily browsed, so that developers do not have to carefully view the sourceCodeTo understand the behavior of a class or method and how to use it.
Jsdoc is a similar tool for JavaScript. Jsdoc is an open-source tool that is licensed by GNU Public License (GPL. Jsdoc is written in Perl, which means that a Windows user must first install a Perl runtime environment. (For most Linux and UNIX operating systems, Perl is a standard part .)

1.

Since Perl has been installed in Linux, I will not describe how to install Perl here.

2,

Install jsdoc:

Download the latest jsdoc in http://code.google.com/p/jsdoc-toolkit/, my isJsdoc Toolkit version 2.4.0

3.

Mark usage:

4.

Generate document:

Java-jar jsrun. Jar APP/run. js-a-e = gb18030-T = templates/jsdoc test/*. js