JSDoc 3 generates javascript API documentation

Source: Internet
Author: User

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 appropriate tags and types. It is not only convenient for us to read, but also a good habit. The greater benefit is that we can generate help documents based on these annotations. The following is a more standard javascript annotation example. 12345678910111213141516171819202122232425262728293031323334353637/*** MyClass class * @ class MyClass * @ constructor */function MyClass () {/*** a property * @ property a * @ type int **/var a = 0; /** get the value of A @ memberof MyClass @ method getA @ param returnType {int} and the value to be set @ example ele. setReturnType ('20140901'); **/function setA (a) {this. a = a;}/** set the value of A @ memberof MyClass @ method getA @ param returnType {int} to the value of @ example ele. setReturnType ('20140901'); **/function getA () {return ;}}

Related Article

Contact Us

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.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.