在Visual Studio中为JavaScript生成javadoc

Question

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

不可思议的是,我必须在Visual Studio 2013上完成它,看起来没有什么可以帮助Javadoc注释块.我想至少在我这样做时: /**+ enter生成:

/**
 *
 */

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

我是否真的在寻找一些不存在的东西,或者是否有一些我错过的东西？(希望如此)

Answer 1

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

GitHub上提供的源代码

引自GitHub自述文件:

DocStubsJs是一个相当简单的插件,它使用事件和字符串解析来确定何时以及如何插入文档存根.它基本上只是用于识别文档注释bock初始化程序的关键笔划.(对于VSDoc为"///",对于JSDoc为"/**")一旦确定这些已在空行中输入,则它会解析它周围的行以确定是否添加新的注释行,创建文档注释存根,或什么都不做.

注意:

对于JSDoc注释,在函数头上方的行上键入"/**"后,将添加参数标记以及返回标记.(对于Web Essentials用户,请注意:您可能必须在Web Essentials的JavaScript选项中禁用多行注释的自动完成才能使其生效.)