示例
//(双斜线)与代码之间保留一个空格，并且//(双斜线)与注释文字之间保留一个空格。
示例
单独一行：//(双斜线)与注释文字之间保留一个空格。
示例
若开始和结束都在一行，推荐采用单行注释。若至少三行注释时，第一行为，最后行为，其他行以开始，并且注释文字与保留一个空格。
函数(方法)注释也是多行注释的一种，但是包含了特殊的注释要求，参照JSDoc。
以下字段并不是全部，全部请参考或
常用注释关键字
文档注释将会以预定格式出现在API文档中。它以“/”开头，以“*/”结束，其间的每一行均以“*”开头（均与开始符的第一个“*”对齐），且注释内容与“*”间留一个空格。
文档注释必须包含一个或多个注释标签。
应该做的
不该做的
参数和返回值类型Type：string、boolean、number、object、array、function
基本方法块注释
如果描述不能描述清楚，添加例子来描述。
基本方法块注释-注释过长时
如果需要折行则在文本中使用标签
基本方法块注释-参数可选
基本方法块注释-带默认值
方法块注释特殊参数
如果描述不能描述清楚，添加例子来描述。 如果方法中有异常处理，标记异常处理注释
如果有返回值增加@returns 如果没有省略此属性
文件注释
在文件头部增加文件注释
变量注释
将关键的变量进行特殊注释，生成到文档中
常量注释
将关键常量进行特殊注释，生成到文档中，如果有默认值增加属性
枚举注释
类的注释
默认情况先一个function就是一个类，ES6中使用Class来表示一个类 我们项目中使用class.js来实现类，在我们项目中使用类注释时需要在后边增加类名，不然jsdoc无法自动识别类名
类的属性
类的属性和变量都会生成到jsdoc文档的Member模块中，在类中使用属性标识
版权声明：
本文来源网络，所有图片文章版权属于原作者，如有侵权，联系删除。
本文网址：https://www.mushiming.com/mjsbk/7000.html