javascript@description注释
js中
vue 组件中包含两种注释：
头部 解释组件的功能
⽅法部分： 解释该⽅法 执⾏的作⽤
头部
<!--
* author: lyx
* time: 2021/10/22
* des:  检查填报- 隧道-⼟建的新增表单
* mark:
*
-->javascript说明
methods: {}
/**
* @description  详情查看接⼝返回
* @param  { String } fdObjectid
* @param {Array}[1,2,3,]
* @return {Num} result 结果
*/
loadMsgFromList(id){
代码逻辑
},
/**
* @description 减法运算
* @param {Num} num1 减数
* @param {Num} num2 被减数
* @return {Num} result 结果
*/
function minus(num1,num2){
return num1 – num2;
}
扩展
@param @argument 指定参数名和说明来描述⼀个函数参数
@returns 描述函数的返回值
@author 指⽰代码的作者
@deprecated 指⽰⼀个函数已经废弃，⽽且在将来的代码版本中将彻底删除。要避免使⽤这段代码
@see 创建⼀个HTML链接，指向指定类的描述
@version 指定发布版本
@requires 创建⼀个HTML链接，指向这个类所需的指定类
@throws @exception 描述函数可能抛出的异常的类型
{@link}创建⼀个HTML链接，指向指定的类。这与@see很类似，但{@link}能嵌在注释⽂本中
@fileoverview 这是⼀个特殊的标记。如果在⽂件的第⼀个⽂档块中使⽤这个标记，则指定该⽂档块的余下部分将⽤来提供这个⽂件的概述@class 提供类的有关信息，⽤在构造函数的⽂档中
@constructor 明确⼀个函数是某个类的构造函数
@type 指定函数的返回类型
@extends 指⽰⼀个类派⽣了另⼀个类。JSDoc通常⾃⼰就可以检测出这种信息，不过，在某些情况下则必须使⽤这个标记
@private 指⽰⼀个类或函数是私有的。私有类和函数不会出现在HTML⽂档中，除⾮运⾏JSDoc时提供了–private命令⾏选项
@final 指⽰⼀个值是常量值。要记住JavaScript⽆法真正保证⼀个值是常量
@ignore JSDoc忽略有这个标记的函数

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。