0

0

JS注解怎么注释参数_ JS函数参数注解的详细写法与作用

星夢妙者

星夢妙者

发布时间:2025-11-20 19:19:01

|

715人浏览过

|

来源于php中文网

原创

jsdoc参数注释是javascript中通过/* /语法描述函数参数的文档注释,使用@param标注类型、名称、可选性及默认值,如{number} a - 第一个加数,支持可选[silent]、默认值[name='guest']及联合类型{string|number},虽不影响运行,但能提升ide智能提示、辅助类型检查、生成html文档并促进团队协作,增强代码可读性与维护性。

js注解怎么注释参数_ js函数参数注解的详细写法与作用

JavaScript 本身不支持像 Java 那样的“注解”(Annotation),但开发者常通过 JSDoc 工具在代码中添加参数注释,用于描述函数参数类型、作用等信息。这种注释方式虽不会影响运行,但能提升代码可读性,并被编辑器或构建工具识别,实现智能提示和类型检查。

什么是 JSDoc 参数注释

JSDoc 是一种用于 JavaScript 的文档注释语法,写在函数或变量上方,以 /** 开头,*/ 结尾。其中 @param 标签专门用来描述函数参数。

基本结构如下:

/**
 * @param {类型} 参数名 - 说明文字
*/

TicNote
TicNote

出门问问推出的Agent AI智能硬件

下载

@param 的详细写法

@param 支持指定参数类型、名称、是否可选、默认值以及描述信息。

  • 基础类型注释
    /**
     * 计算两数之和
     * @param {number} a - 第一个加数
     * @param {number} b - 第二个加数
     * @returns {number} 和值
    */
    function add(a, b) {
      return a + b;
    }
  • 可选参数标记:用方括号 [] 表示可选
    /**
     * 发送消息
     * @param {string} text - 消息内容
     * @param {boolean} [silent] - 是否静默发送(可选)
    */
    function sendMessage(text, silent) { ... }
  • 带默认值的参数:可在描述中注明
    /**
     * 设置用户配置
     * @param {Object} options - 配置项
     * @param {string} [options.name='Guest'] - 用户名,默认为 'Guest'
     * @param {number} [options.age=18] - 年龄,默认 18
    */
  • 复杂类型与联合类型
    使用 {Object}{Array}{string|number}
    /**
     * 处理数据
     * @param {Array} tags - 字符串标签数组
     * @param {('info'|'warn'|'error')} level - 日志级别
    */

参数注释的作用

虽然 JSDoc 不改变 JS 运行逻辑,但它在开发过程中有实际价值:

  • 增强 IDE 智能提示:VSCode、WebStorm 等编辑器能根据注释提示参数类型和说明。
  • 辅助类型检查:配合 TypeScript 或 ESLint,可做静态分析,发现潜在错误。
  • 生成项目文档:使用工具如 jsdoc 命令行可自动生成 HTML 文档。
  • 团队协作更清晰:新人阅读代码时能快速理解函数用途和参数含义。

基本上就这些。合理使用 JSDoc 的 @param 注释,能让 JavaScript 代码更规范、易维护,尤其在大型项目或库开发中非常实用。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
TypeScript工程化开发与Vite构建优化实践
TypeScript工程化开发与Vite构建优化实践

本专题面向前端开发者,深入讲解 TypeScript 类型系统与大型项目结构设计方法,并结合 Vite 构建工具优化前端工程化流程。内容包括模块化设计、类型声明管理、代码分割、热更新原理以及构建性能调优。通过完整项目示例,帮助开发者提升代码可维护性与开发效率。

45

2026.02.13

TypeScript全栈项目架构与接口规范设计
TypeScript全栈项目架构与接口规范设计

本专题面向全栈开发者,系统讲解基于 TypeScript 构建前后端统一技术栈的工程化实践。内容涵盖项目分层设计、接口协议规范、类型共享机制、错误码体系设计、接口自动化生成与文档维护方案。通过完整项目示例,帮助开发者构建结构清晰、类型安全、易维护的现代全栈应用架构。

186

2026.02.25

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

970

2023.08.02

java中boolean的用法
java中boolean的用法

在Java中,boolean是一种基本数据类型,它只有两个可能的值:true和false。boolean类型经常用于条件测试,比如进行比较或者检查某个条件是否满足。想了解更多java中boolean的相关内容,可以阅读本专题下面的文章。

366

2023.11.13

java boolean类型
java boolean类型

本专题整合了java中boolean类型相关教程,阅读专题下面的文章了解更多详细内容。

42

2025.11.30

scripterror怎么解决
scripterror怎么解决

scripterror的解决办法有检查语法、文件路径、检查网络连接、浏览器兼容性、使用try-catch语句、使用开发者工具进行调试、更新浏览器和JavaScript库或寻求专业帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

471

2023.10.18

500error怎么解决
500error怎么解决

500error的解决办法有检查服务器日志、检查代码、检查服务器配置、更新软件版本、重新启动服务、调试代码和寻求帮助等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

373

2023.10.25

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

738

2023.08.03

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PostgreSQL 教程
PostgreSQL 教程

共48课时 | 10.3万人学习

Django 教程
Django 教程

共28课时 | 4.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号