VSCode JSDoc 自动文本到块注释转换工具      

使用 @example 标签快速解决 JSDoc 文本换行符的辅助工具,适用于 JavaScript/TypeScript
输入文字自动生成评论 (Text)
⇊⇊⇊
⇈⇈⇈
输入评论自动恢复文本 (Comment)

VSCode / Cursor JSDoc:增强 JavaScript 文档


JSDoc - Wikipedia
JSDoc 是一款功能强大的 JavaScript 文档生成器。它使用特殊格式的注释为您的代码创建详细的 API 文档。通过向您的 JavaScript 文件添加 JSDoc 注释,您可以提供有关函数、类和模块的清晰且结构化的信息。

JSDoc 的主要功能:

类型信息
函数参数和返回值
类和方法描述
模块文档
JSDoc 中一个特别有用的标签是 @example 标签。此标签允许您在文档中包含代码示例。我们的工具与众不同之处在于它能够在 @example 标签内保留格式、缩进和换行符。这意味着您可以编写更易读、更真实的代码示例,让开发人员更容易理解如何使用您的函数或类。

示例用法:
/**
 * Calculates the sum of two numbers.
 * @param {number} a - The first number.
 * @param {number} b - The second number.
 * @returns {number} The sum of a and b.
 * @example
 * // This example preserves formatting and line breaks
 * const result = add(5, 3);
 * console.log(result);
 * // Output: 8
 */
function add(a, b) {
    return a + b;
}
通过使用我们的在线 JSDoc 注释生成器,您可以轻松创建格式良好的文档,其中包括代码示例中保留的格式,从而使您的 JavaScript 文档更加清晰、有效。