@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) { //ts
return number + str;
ts中可以定义interface后使用上述注释,可以在使用时能够给出提示信息
参考:
JSDoc 注释规范 - jndream - 博客园
jsDoc,顾名思义,jsDoc是一个用于
JavaScript
的API文档生成器,类似于Javadoc或phpDocumentor。它根据
JavaScript
文件中的
注释
信息,生成JS应用程序或模块的API文档。通过使用JSDoc标记如:命名空间,类,方法参数等,从而使
开发
者能够轻易地阅读代码,掌握代码定义的类和和其属性和方法,从而降低维护成本并提高
开发
效率。
JSDoc中文文档
JSDoc官网
JSDoc
注释
通常应该放在代码被记录之前。为了被JSDoc解析器识别,每个
注释
必须以/**序列开头,以便由JSD
装载机
ts
doc.json
贡献者公告
该项目欢迎您的贡献和建议。 大多数捐款要求您同意“捐款者许可协议”(CLA),声明您有权并实际上确实授予我们使用您的捐款的权利。 有关详细信息,请访问 。
当您提交拉取
@author 指示代码的作者
@deprecated 指示一个
函数
已经废弃,而且在将来的代码版本中将彻底删除。要避免使用这段代码
@see 创建一个HTML链接,指向指定类的描述
@version 指定发布版本
@requires 创建一个HTML链接,指向这个类所需的指定类
@throws @exception 描述
函数
可能抛出的异常的类型
{@link} 创建一个HTML链接,指.
//
Ts
只会检查类型 不会检查里面的逻辑
// 参数要加类型注解 返回值会类型推断 但是建议添加
const addNums = (a :number, b : number):number {
return a - b;
function mutiply(a : number, b : number):number{
return a * b;
const divide = function(a:number,
我的理解就是起到一个提前说明的意思,比如:
function createArray(length: number, value: any): Array<any> {
let result = [];
for (let i = 0; i < length; i++) {
result[i] = value;
return result;
// 通过调用createArray
函数
能够生成
数据校验是我们日常
开发
过程中常做的工作,其目的性是为了提升我们系统的健壮性,举个简单的例子,我们要做一个创建用户的api接口服务,用户昵称是必填项,那么接口就需要对用户昵称进行非空校验。如果没填昵称抛出异常或者返回一些错误码。
那么问题来了,一次调用可能有n多个参数需要校验,比如用户手机绑定的注册服务,入参如下所示:
public class MobileRegisterDTO extends BaseDTO {
* 手机号
private Strin
如题,本篇我们介绍下
ts
中
函数
型接口。
ts
中
函数
型接口,非常类似于java、c#中使用lambda表达式传入匿名
函数
。因为对象中仅包含一个
函数
,这个对象的全部意义也仅在于那个可被外部调用的
函数
,故而称之为
函数
型接口。
05_interface_func.
ts
*
ts
中接口
*
函数
型接口 ,非常类似于java、c#中使用lambda表达式传入匿名
函数
// ...
* @param copy 深拷贝
* @param _object 如果不传返回为空对象 必须是js的{}对象
* @param _obj 可选 返回传入的@param _object 必须是js的{}对象,
export const copy = (_object: _typeObj, _obj: _typeObj = {}): _typeObj => {
if (!(Object.
作用:用注解来简化xml配置的时候(比如Mybatis的Mapper.xml中的sql参数引入),@Param注解的作用是给参数命名,参数命名后就能根据名字得到参数值,正确的将参数传入sql语句中(一般通过#{}的方式,${}会有sql注入的问题)。
实例说明:
1,使用@Param注解
Mapper接口方法:
public int getUsersDetail(@Param("u...