- {@link ...}, {@linkplain ...}, {@linkcode ...}, {@tutorial ...} 内联标签
- @abstract 抽象，必须由继承者实现（或者覆盖）
- @access 访问级别（private、public或者protected）
- @alias 别名
- @augments 参数
- @author 作者
- @borrows 借用
- @callback 回调函数
- @classdesc 类描述
- @constant 常量
- @constructor 构造函数，可以使用new创建一个实例
- @constructs 构造
- @copyright 版权
- @default 默认值
- @deprecated 弃用的
- @desc 描述
- @enum枚举值
- @event 事件
- @example 范例
- @exports 模块导出（模块化）
- @external 外部模块（模块化）
- @file 文件
- @fires 可触发的事件
- @global 全局对象
- @ignore 忽略
- @inner 内联对象
- @instance 实例
- @kind 标识类型
- @lends 遍历属于同一个标识的所有属性
- @license 软件授权
- @link 内联
- @member 成员
- @memberof 属于某成员
- @method 方法
- @mixes 合并
- @mixin 最小化
- @module 模块（模块化）
- @name 名称
- @namespace 命名空间
- @param 参数
- @private 私有的（访问控制）
- @property 属性
- @protected 受保护的（访问控制）
- @public 公开的（访问控制）
- @readonly 只读的
- @requires 依赖（模块化）
- @return 返回值
- @see 引用
- @since 开始于
- @static 静态的
- @summary 概述
- @this 解释this关键字
- @throws 可能抛出的异常
- @todo 待办事项
- @tutorial 引用指导手册
- @type 类型
- @typedef 自定义类型
- @variation 区分不同的对象具有相同名称的
- @version 版本
need_faith
- 浏览: 82232 次
- 性别:
- 来自: 北京
-
最新评论
-
pl01388514：
很有帮助。一般DB文件可以放到src或者同级Class文件夹 ...
【原创】SQLite学习笔记 -
lian819：
谢谢分享, 这个resource帮我解决了实际的问题, 再次感 ...
【原创】SQLite学习笔记 -
george.hu：
网上有多种多样的方法来实现这个功能，很多地方都利用了判断emp ...
【原创】TextField的emptyText提交验证 -
ansly20060：
怎么用啊？？打开了没有反映
【原创】一个简单的SVG在线图形编辑器 -
need_faith：
liang3331 写道源代码里 少 layoutContro ...
【原创】一个简单的SVG在线图形编辑器
相关推荐
2. **注释标签**：JSDoc 注释中以 `@` 开头的标签用来指定特定的信息，如 `@param` 用于描述函数参数，`@returns` 描述函数返回值等。 ```javascript /** * Book 类，代表一个书本。 * @constructor * @param {...
### JsDoc Toolkit 标签一览表详解 #### 概述 JsDoc Toolkit 是一款功能强大的文档生成工具，它能够帮助开发者根据预定义的注释格式（即JsDoc规范）自动生成高质量的API文档。这对于提高代码可读性、维护性和团队...
ts2jsdoc 带有可选模板的 JSDoc 插件，可根据 Typescript 定义自动添加 JSDoc 注释。概述特征根据 Typescript 的类型自动添加 JSDoc 注释： 添加变量和属性类型、修饰符和默认值。 添加函数和方法返回类型、修饰符、...
`jsdoc-regex`是一个专门用于匹配JSDoc注释的开源库，它提供了一个更高级、更全面的正则表达式或者一套规则，用于解析JavaScript代码中的JSDoc注释。这个库可能包含了多种正则模式，以适应不同的注释结构和特殊需求...
**jsdoc-x** 是一个专为前端开发者设计的开源库，其主要功能是解析和处理JavaScript代码中的JSDoc注释，从而生成自定义的JavaScript对象。JSDoc 是一种标准化的注释语法，用于为JavaScript代码提供文档，它允许...
幸运的是，这个问题有一个简单的解决办法：使用JSDOC注释。 什么是JSDOC？ JSDOC是一个JavaScript文档生成器工具，它可以根据JavaScript代码生成文档。使用JSDOC注释，可以帮助vscode编辑器更好地理解代码，从而...
coc-docthis coc.nvim的JSDoc扩展名，可从派生为TypeScript / JavaScript文件生成详细的JSDoc注释。安装:CocInstall coc-docthis 指令docthis.documentThis ：在当前位置生成文档构型配置描述默认docthis.returnsTag...
JSDoc 是一种用于注释JavaScript代码的规范，它通过在源代码中添加特定的注释标签来生成文档。这些注释提供了关于函数、类、接口等的元数据，包括参数、返回值、类型信息等。JSDoc 支持多种模板，可以生成不同风格的...
JSDoc注释通常包含`@param`、`@return`、`@class`、`@function`等标签，这些标签提供了丰富的元数据，用于自动生成文档。 **grunt-jsdoc-to-markdown** `grunt-jsdoc-to-markdown`是基于Grunt的任务插件，Grunt是...
JSDoc 提供了一系列预定义的标签，如 `@param`, `@return`, `@function`, `@class`, `@event` 等，使得代码的意图更清晰，同时也方便生成文档。 例如，一个简单的 JSDoc 示例： ```javascript /** * @function ...
JSdoc-Toolkit是一款强大的JavaScript文档生成工具，它基于JSDoc规范，用于从注释中提取代码信息，并生成清晰、结构化的API文档。通过在代码中添加特定格式的注释，开发者可以方便地为项目创建专业级别的文档，提高...
`jsdoc-toolkit`是一款基于JavaScript的文档生成工具，它解析JavaScript源代码中的JSDoc注释，然后根据这些注释生成HTML格式的文档。JSDoc是一种在代码中嵌入文档注释的标准，类似于Java的Javadoc。通过使用特定的...
5. **插件支持**: JSDoc 允许通过插件扩展其功能，例如添加新的注释标签、处理特殊类型的文档等，这极大地增强了其灵活性和适用性。 6. **多语言支持**: JSDoc 输出的文档可以是多语言的，这得益于其对i18n的支持，...
JSDoc支持一系列预定义的注释标签，用于描述函数参数、返回值、作者信息等。以下是一些常用的注释标签： - **`@param`**：描述函数参数，如`@param {String} name The name of the Person.`。 - **`@return`** 和 *...
2. **JSDoc**: JSDoc注释是一种标准化的方式，通过在JavaScript代码中使用特殊的标签（如`@param`, `@return`, `@function`等）来描述函数、变量和类。当Eclipse中的Spket解析这些注释时，可以提供实时的代码提示和...
JSDoc 提供了诸如 `@param`, `@return`, `@example` 等标签，用于描述函数参数、返回值和示例用法。 `vigour-jsdoc2md` 将 JSDoc 的注释解析并转换成 Markdown 格式，Markdown 是一种轻量级的标记语言，易于阅读和...
它通过解析源代码中的特殊注释（也称为JSDoc注释），为开发人员提供清晰、结构化的文档，帮助他们更好地理解和使用代码库。在本文中，我们将深入探讨jsDoc的基本用法、主要特性、以及如何有效地集成到开发工作流中。...
“ Document This”是Visual Studio Code扩展，可以自动为TypeScript和JavaScript文件生成详细的JSDoc注释。 标签 支持JSDoc和Closure Compiler标签：@ class，@ description，@ enum，@ export，@ function，@ ...
注释的格式和规范通常依据语言和团队标准而定，例如在C#中，我们经常使用XML注释为类、方法、属性等添加文档，而在JavaScript中，JSDoc是一种常见的注释方式。 针对C#，Visual Studio的自动注释插件可以极大地简化...
在这个例子中，`@description` 和 `@param` 是 jsdoc 标签，它们提供了关于 `theme-color` 函数的详细信息。 在实际使用 `dgeni-less-package` 时，我们需要配置好 `dgeni`，包括指定要处理的文件、解析器和模板等...