JavaScript的@param注解

在这里插入图片描述



@property name {String} 交互类型
@property params {Object} 附带参数 
@property func {Function} 回调函数

在这里插入图片描述

  /**
 * 获取事件在列表中的位置
 * @param context
 * @param callback
 * @private
 */
_evIndex(event, context, callback) {
    let index = -1;
    for (let i = 0; i <= event.length; i++) {
        if (event[i].context === contex && event[i].callback === callback) {
            index = i;
            break;
        }
    }
    return index;
}

/**
 * 绑定事件
 * @param eventType string 事件类型
 * @param context Object callback的this作用域
 * @param callback
 */
on(context, eventType, callback) {
    if (typeof eventType != 'string' || typeof callback != 'function') {
        return;
    }
    let event = this.store[eventType];
    let eventObj = {
        context: context,
        callback: callback
    };
    if (!event || !Array.isArray(event)) {
        this.store[eventType] = [eventObj];
    } else if (this._evIndex(event, context, callback) < 0) {
        this.store[eventType].push(eventObj);
    }
}
  



@module

标明当前文件模块,在这个文件中的所有成员将被默认为属于此模块,除非另外标明

@submodule

针对模块的划分,处于@module之下

@class

标示一个类或者一个函数

@constructor

当使用对象字面量形式定义类时,可使用此标签标明其构造函数

@callback

标明此方法是一个回调函数

@event

标明一个可触发的事件函数,一个典型的事件是由对象定义的一组属性来表示。

@constant

常量标识

@member/@var

记录一个基本数据类型的成员变量
@method

标记一个方法或函数

@param

标记方法参数及参数类型

@property

标明一个对象的属性

@readonly

只读

@return

标明返回值、类型及描述

@type

描述代码变量的类型

@description

如果在注释开始描述可省略此标签

@enum

一个类中属性的类型相同时,使用此标签标明

@example

示例,代码可自动高亮

@exports

标识此对象将会被导出到外部调用

@ignore

忽略此注释块

@link

内联标签,创建一个链接,如 `{@link http://github.com Github}`

@name

指定一段代码的名称,强制 JSDoc 使用此名称,而不是代码里的名称

@namespace

指定一个变量为命名空间变量

@static

描述一个不需实例即可使用的变量

@summary

对描述信息的短的概述

@throws

描述方法将会出现的错误和异常

@todo

描述函数的功能或任务

@tutorial

插入一个指向向导教程的链接
     * @param {Object} state vuex state
     * @param {Boolean} collapse is collapse

### Param在不同编程环境中的用法和含义 #### JavaScript 中的 `@param` `@param` 是 JSDoc 的一部分,JSDoc 是一种基于注释的语言,允许开发者为 JavaScript 代码编写文档。通过使用特定格式的注释标签(如 `@param`),可以描述函数或方法接受的参数名称、类型以及用途[^1]。 ```javascript /** * 这是一个示例函数. * * @param {string} paramName - 参数说明文字 */ function exampleFunction(paramName) { // 函数体 } ``` #### Linux 内核模块中的 `module_param` 在 Linux 内核编程中,`module_param()` 宏定义用来声明可以在加载时传递给内核模块的变量。这使得用户能够在不重新编译的情况下调整某些行为或者配置选项。宏的第一个参数是要设置的变量名;第二个指定了该变量的数据类型;第三个则是权限位,决定了谁能够读写这个参数[^2][^4]。 ```c static int value = 0; module_param(value, int, S_IRUGO | S_IWUSR); MODULE_PARM_DESC(value, "An integer parameter"); ``` #### URL 查询字符串中的参数 当涉及到 Web 开发时,URL 可能会携带查询参数作为其组成部分之一。这些附加到 URL 后面的关键字/值对被称为查询参数,它们通常用于向服务器发送额外的信息以便于请求处理。解析这类参数有助于构建动态网页内容或是实现 API 接口等功能[^3]。 例如,在地址栏输入如下链接: ``` https://example.com/search?q=hello&lang=en ``` 这里的 `q=hello` 和 `lang=en` 就是两个查询参数。 #### Java 或 MyBatis 框架下的 `@Param` 对于像 MyBatis 这样的持久层框架而言,`@Param` 注解被广泛应用于映射 SQL 映射文件内的命名占位符与实际传入的方法参数之间建立联系。这意味着如果一个 Mapper 方法接收多个同类型的参数,则可以通过此注解指定每个参数对应的具体字段名[^5]。 ```java public interface UserMapper { List<User> findUser( @Param("userName") String userName, @Param("password") String password ); } ```
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值