【问题标题】:Generate javadoc for JavaScript in Visual Studio在 Visual Studio 中为 JavaScript 生成 javadoc
【发布时间】:2015-06-22 21:01:58
【问题描述】:

我需要为一个 JavaScript 项目生成文档,我想用 Javadoc 来做。

不幸的是,我必须在 Visual Studio 2013 上执行此操作,而且看起来没有什么可以帮助 Javadoc cmets 块。至少当我这样做时,我希望: /** + enter 生成:

/**
 *
 */

我在 Stackoverflow 和 Microsoft 网站上寻找过插件或类似问题,但我只找到了 Doxygen 的插件或解决方案。

我真的在寻找不存在的东西,还是我错过了什么? (希望如此)

【问题讨论】:

    标签: javascript visual-studio visual-studio-2013 javadoc


    【解决方案1】:

    对于 Visual Studio,您可以使用 DocStubsJs,这是 Visual Studio 2012+ 的扩展,可在 JavaScript 和 TypeScript 编辑器中为 JSDoc 和 VSDoc 自动生成文档注释存根。

    GitHub上提供的源代码

    引用自 GitHub README:

    DocStubsJs 是一个相当直接的插件,它使用事件和 字符串解析以确定何时以及如何插入文档存根。它 基本上只是为了识别文件而观察击键 评论块初始化程序。 ("///" 用于 VSDoc,"/**" 用于 JSDoc) 一次 它已确定这些已在空行中输入,然后 它解析它周围的行以确定是否添加新的 注释行,创建文档注释存根,或者什么都不做。

    注意:

    对于JSDoc cmets,将在函数标题上方的行中键入“/**”后添加参数标记以及返回标记。 (Web Essentials 用户请注意:您可能必须在 Web Essentials 的 JavaScript 选项中禁用多行 cmets 的自动完成才能使其正常工作。)

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2021-10-09
      • 2013-06-21
      • 2016-07-14
      • 2020-04-20
      • 1970-01-01
      • 1970-01-01
      • 2023-03-30
      • 1970-01-01
      相关资源
      最近更新 更多