把函数作为参数传递时，类型描述最容易写得含糊不清。JSDoc用@param配合function关键字能明确入参和返回值，TypeScript则用箭头函数类型直接约束签名。比如回调场景，写成@param {function(string): number} cb比笼统写function更利于编辑器提示。本文对比两种主流方案的语法...

栏目：JavaScript 时间：08-09 JSDoc TypeScript function_type

在JavaScript项目开发中，良好的注释规范不仅能提升代码可读性，还能通过JSDoc自动生成API文档。很多开发者不清楚如何正确使用JSDoc标签来描述函数、参数和返回值。本文介绍JSDoc的基本写法，包括常用标签如param、returns、typedef的使用方式，并说明如何通过工具将注释转换为H...

栏目：JavaScript 时间：07-24 JavaScript JSDoc 文档生成 注释规范 代码注释

在JavaScript开发过程中，很多开发者需要动态获取函数的JSDoc注释来实现文档生成、类型校验等功能。本文将介绍几种常见的动态提取函数JSDoc注释的方法，包括基于Function.prototype.toString的方式、借助AST解析工具的实现思路，同时会详细说明这些方法存在的局限性，比如无法获...

栏目：JavaScript 时间：06-28 JavaScript JSDoc 动态提取 函数注释

在JavaScript项目开发中，JSDoc注释常用于标注函数的参数、返回值、功能说明等信息，很多时候我们需要从函数中提取这些注释用于文档生成、代码分析等场景。很多开发者不清楚具体实现方式，本文将介绍两种主流的提取方法，分别是基于正则表达式的基础提取方式和基于抽象语法树AST...

栏目：JavaScript 时间：06-26 JavaScript JSDoc AST 函数注释提取 正则表达式

在JavaScript开发中，使用JSDoc为对象添加类型注释可以提升代码的可维护性和可读性。很多开发者会遇到需要定义同时包含固定属性和动态扩展属性的对象类型的场景，比如既有必填的id、name字段，又允许添加任意其他自定义字段的配置对象。本文将详细介绍JSDoc的相关语法，讲解如何...

栏目：JavaScript 时间：06-22 JSDoc 对象类型定义 动态属性 固定属性 类型注释

在JavaScript开发中，很多开发者不清楚如何对函数的返回值进行规范注解，也不了解返回值注解的实际作用。本文围绕JS返回值注解的使用方法展开，详细介绍JSDoc规范下返回值注解的语法格式，结合不同返回值类型的实际示例讲解注释写法，同时说明返回值注解在代码维护、类型提示、团...

栏目：JavaScript 时间：06-17 JSDoc 函数返回值注解 JS注释 类型注解 代码可读性

在JavaScript开发中，函数参数往往没有明确的类型约束和必填性提示，很容易导致调用时出现参数缺失的问题。很多开发者想知道如何通过注解的方式标注函数的必填参数，让代码可读性更强，也能在开发阶段提前发现参数错误。本文会介绍常用的JS注解规范，讲解如何使用JSDoc等工具标注...

栏目：JavaScript 时间：06-14 JS注解 函数必填参数 注解规范 JSDoc