JavaScript常用注释规范

@param/@argument 指定参数名和说明来描述一个函数参数

@returns 描述函数的返回值

@author 指示代码的作者

@deprecated 指示一个函数已经废弃，而且在将来的代码版本中将彻底删除。尽量避免使用这段代码

@version 指定发布版本

@throws @exception 描述函数可能抛出的异常的类型

@class 提供类的有关信息，用在构造函数的文档中

@constructor 明确一个函数是某个类的构造函数

@type 指定函数的返回类型

@extends 指示一个类派生了另一个类。JSDoc通常自己就可以检测出这种信息，不过，在某些情况下则必须使用这个标记

@final 指示一个值是常量值。要记住JavaScript无法真正保证一个值是常量

@default 指示参数的默认值

使用方式：

/*** @description一个示例函数* @author 泽 pro max plus* @version 0.0.1* @param number 输入一个数字* @param str 输入一个字符串* @returns 返回相加的结果*/export default function example(number: number, str: string) { //tsreturn number + str;
}

ts中可以定义interface后使用上述注释，可以在使用时能够给出提示信息

参考：JSDoc 注释规范 - jndream - 博客园

JavaScript常用注释规范相关推荐

JSDoc的常用注释规范
JSDoc的常用注释规范 JSDoc本质是代码注释官网--https://jsdoc.zcopy.site/ 手册网API--https://www.shouce.ren/api/view/a/13 ...
【转】JavaScript常用代码书写规范
javascript 代码规范代码规范我们应该遵循古老的原则:"能做并不意味着应该做". 全局命名空间污染总是将代码包裹在一个立即的函数表达式里面,形成一个独立的模块. 不推荐 ...
javascript 常用技巧
如内容超出单元格,则隐藏 style="TABLE-LAYOUT: fixed" 让弹出窗口总是在最上面: <body οnblur="this.focus();& ...
JSDoc 注释规范
JSDoc 注释规范什么是 JSDoc JSDoc 是一个根据 JavaScript 文件中注释信息,生成 JavaScript 应用程序或模块的API文档的工具.你可以使用 JSDoc 标记如:命 ...
doxygen 注释规范_编程规范 - doxygen注释规范示例（C++）
doxygen注释规范示例(C++) doxygen能根据code的注释自动生成code的帮助文档,并且doxygen是一个跨平台的开源的软件,但是要生成帮助文档,code内的注释必须按一定规则书写. ...
javaScript常用知识点有哪些
javaScript常用知识点有哪些一.总结一句话总结:int = ~~myVar, // to integer | 是二进制或, x|0 永远等于x:^为异或,同0异1,所以 x^0 还是永远等 ...
javascript常用代码大全
http://caibaojian.com/288.html 原文链接 jquery选中radio//如果之前有选中的,则把选中radio取消掉 $("#tj_cat .pro_ca ...
JavaScript的编码规范
JavaScript 文件引用 JavaScript 程序应该尽量放在 .js 的文件中,需要调用的时候在 HTML 中以 < script src="filename.js" ...
107条javascript常用小技巧
107条javascript常用的方法技巧,呵呵!为什么就是108呢? 1.document.write(""); 输出语句 2.JS中的注释为// 3.传统的HTML文档顺序是: ...
详细聊聊Javadoc注释规范
Javadoc 注释规范 1. 注释分类 2. Java文档和Javadoc 3. 文档注释的格式 3.1 文档和文档注释的格式化 3.2 文档注释的三部分 4. 使用Javadoc标记 4.1 ...

JavaScript常用注释规范

JavaScript常用注释规范相关推荐

最新文章

热门文章