脚本宝典收集整理的这篇文章主要介绍了javascript代码实例教程-JSDoc 3 生成javascript API文档，脚本宝典觉得挺不错的，现在分享给大家，也给大家做个参考。小宝典致力于为广大程序猿（媛）提供高品质的代码服务，请大家多多光顾小站，小宝典在此谢过。 烟火_
JSDoc 3 生成javascript API文档
一、javascript注释规范
我们在编写javascript文件的时候，一般会添加一些注释。例如一些文件、类、方法和属性都应该用合适的标记和类型进行注释。这里不但方便我们的阅读，也能养成一个好的习惯。更大的好处是，我们可以根据这些注释生成帮助文档。如下就是一个比较规范的javascript注释例子。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
/**
* MyClass类
* @class MyClass
* @constructor
*/
function MyClass() {
/**
* a属性
* @type int
**/
VAR a = 0;
/**
获得A的值
@memberof MyClass
@method getA
@param returnType {int} 要设置的值
@example ele.setReturnType('0000');
**/
function setA(a) {
this.a = a;
}
/**
设置A的值
@memberof MyClass
@method getA
@param returnType {int} 要设置的值
@example ele.setReturnType('0000');
**/
function getA() {
return a;
}
}
觉得可用，就经常来吧！ 脚本宝典 欢迎评论哦！ js脚本，巧夺天工，精雕玉琢。小宝典献丑了！
以上是脚本宝典为你收集整理的javascript代码实例教程-JSDoc 3 生成javascript API文档全部内容，希望文章能够帮你解决javascript代码实例教程-JSDoc 3 生成javascript API文档所遇到的问题。
本图文内容来源于网友网络收集整理提供，作为学习参考使用，版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ：384754419，请注明来意。