JSDoc Toolkit recently released the 2.3.2 version, mainly to the previous version of the repair.
If you need to use Ant,jsdoc and an ant plug-in: JSDoc Toolkit ant Task
Download JSDoc Toolkit2.3.2:http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.3.2.zip
Command nam
JsDoc Toolkit recently released version 2.3.2, which mainly fixes previous versions.If you need to use Ant, JsDoc also has an Ant plug-in: JsDoc Toolkit Ant TaskDownload JsDoc Toolkit2.3.2: http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.3.2.zipCommand Name Descrip
JsDocToolkit is a tool used to format js descriptions into documents. Developers can easily export documents by writing comments according to the JsDoc specifications. It is a JsDoc generation tool recommended by google. JsDoc Toolkit recently released version 2.3.2, which mainly fixes previous versions.
If you need to use Ant,
In the previous blog post discussion of automation engineering issues, NODEJS-based, gulp, grunt JSDoc plug-ins are used for document automation. This paper discusses the implementation of automation based on Java environment.One, Java installation and environment configurationFor Java installation and environment configuration, you can refer to the blog Yui Compressor for Sublime Text2Second, Jsdoc-tookit
As an experienced Web application developer, you may be able to skillfully apply some server-side technology (or a variety of server-side technologies) to build Web applications. We have seen that over the past few years, server-side technology has developed significantly, server-side software development is becoming more and more easy, and more robust, in contrast, the client technology is basically left aside. This situation has been improved by the advent of Ajax technology, as developers now
JsDoc Toolkit recently released version 2.3.2, which mainly fixes previous versions.
If you need to use Ant, JsDoc also has an Ant plug-in: JsDoc Toolkit Ant Task
Download JsDoc Toolkit2.3.2: http://jsdoc-toolkit.googlecode.com/files/jsdoc_toolkit-2.3.2.zip
Command Name Des
With the popularity of Web2.0, JavaScript has become a recognized programming language, due to the emergence of a large number of JS open source framework, the use of JavaScript development projects more and more, more and more. At the same time, there are more and more JavaScript development problems exposed, such as performance, Web page loading speed, etc., in which JavaScript document maintenance has become a problem for developers to solve.
Many modern programming languages have their own i
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 th
JSDoc can generate API documents similar to JavaDoc, which is essential for front-end development.
Download jsdoc-tookit (http://code.google.com/p/jsdoc-toolkit/) and jsdoc-tookit-ant-task (http://code.google.com/p/jsdoc-toolkit-ant-task/), the escape Function of CSDN is pro
First, download the jsdoc-JavaScript documentation tool. Http://sourceforge.net/projects/jsdoc.
1. download and install the Perl environment, ActivePerl-5.10.0.1003-i686-linux-glibc-2.3.2-285500.deb. The website http://www.activeperl.com/has been downloaded. A few simple information may not be considered a registration.
2. Run Perl jsdoc. pl test. js. Generally,
in the path variable (existing without new):%java_home%\bin;%java_home%\jre\bin (Note the ";" between the variable values) Separated4. "Start"-"Run"-enter "Javac" and "enter", if you can print the usage instructions correctly, the configuration is successful!Analysis of supplemental environment variables:Installation path for JAVA_HOME:JDKClasspath:java load Classpath, only the class is recognized by the Java command in Classpath, and a "." is added before the path. Represents the current path.
the class used in the document of the constructor@constructor explicitly that a function is a constructor of a class@type The return type of the specified function@extends indicates that a class derives from another class. JSDoc is usually able to detect this information by itself, but in some cases it must be used@private indicates that a class or function is private. Private classes and functions do not appear in HTML documents unless –private comm
Jsdoc-Toolkit is basically used on the Internet, so it won't steal others. Share some of the advanced usage I haven't found:
1. how to specify the script file list for generating a document. For example, a script library contains many files and only wants to generate a part of the doc. The command line does not have relevant parameters. You can use the configuration file, the parameter "_" is the source file list.
{
2. How to insert exte
the file. @class provides information about the class, which is used in the document of the constructor. @constructor explicitly that a function is a constructor for a class. @type Specifies the return type of the function. @extends indicates that a class derives from another class.This information is usually detected by JSDoc itself, but in some cases this tag must be used. @private indicates that a class or function is private.Private classes and f
Fire_jsdoc 3 generates javascript API documentation 1. javascript annotation specifications when writing javascript files, some annotations are generally added. For example, some files, classes, methods, and attributes should be annotated with
工欲善其事 its prerequisite, this gives the WEB developer to recommend several excellent open source document generation tool, hope to be helpful to everyone.1. JavaScriptJSDoc 3Https://www.oschina.net/p/jsdocThis is a tool that generates API documentation for JavaScript applications, libraries, and modules based on annotated information in JavaScript files. You can use it to record such as: namespaces, classes, methods, method parameters, and so on. The project also spawned a number of templates and
I have been working on JS document generation software recently.
Currently, jsdoc is the main open source project in this field. First, let's introduce the jsdoc itself. It is a document tool developed in Java (mainly JavaScript) to directly process strings. Because javscript is very flexible, JavaScript document generation is naturally less accurate and effective than Java and so on.
JavaScript document generation is a headache, but now there are open-source tools available to use -- jsdoc.
Its official site address: http://jsdoc.sourceforge.net/
Release version is: http://sourceforge.net/projects/jsdoc
Jsdoc is based on JavaScript
Code Generate the corresponding help document for the annotation in, which defines a set of annotation label sp
I believe that experts are already familiar with these tools. I would like to recommend them to more beginners:
C ++ annotation document generation tool: doxygen: Http://www.vckbase.com/code/softeng/engineering/doxygen.rarLocation: http://down1.chinaunix.net//distfiles/doxygen-1.4.7.src.tar.gz
Javascript annotation document generation tool: jsdocDownload location: http://sourceforge.net/projects/jsdoc/ (exact download location: http://nchc.dl.source
The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion;
products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the
content of the page makes you feel confusing, please write us an email, we will handle the problem
within 5 days after receiving your email.
If you find any instances of plagiarism from the community, please send an email to:
info-contact@alibabacloud.com
and provide relevant evidence. A staff member will contact you within 5 working days.