Generate javadoc for JavaScript in Visual Studio - Stack Overflow

admin管理员组

文章数量:1415484

I need to generate documentation for a JavaScript project, and I would like to do it with Javadoc.

Unhopefully, I have to do it on Visual Studio 2013, and it looks like there is nothing to help Javadoc ments blocks. I would like at least when I do this : /** + enter To generate that :

/**
 *
 */

I've looked for plugins or similar questions, on Stackoverflow and on Microsoft website, but I only found plugins or solutions for Doxygen.

Do am I really looking for something that doesn't exist, or is there something that I missed ? (I hope so)

I need to generate documentation for a JavaScript project, and I would like to do it with Javadoc.

Unhopefully, I have to do it on Visual Studio 2013, and it looks like there is nothing to help Javadoc ments blocks. I would like at least when I do this : /** + enter To generate that :

/**
 *
 */

I've looked for plugins or similar questions, on Stackoverflow and on Microsoft website, but I only found plugins or solutions for Doxygen.

Do am I really looking for something that doesn't exist, or is there something that I missed ? (I hope so)

• javascript
• visual-studio
• visual-studio-2013
• javadoc

Share Improve this question Follow edited Jan 15, 2016 at 8:48 Aracthor asked Apr 16, 2015 at 12:40 AracthorAracthor 5,91766 gold badges3333 silver badges6161 bronze badges

Add a ment  | 

1 Answer 1

Sorted by: Reset to default 6 +50

For Visual Studio you could use DocStubsJs, An extension for Visual Studio 2012+ to auto generate documentation ment stubs for JSDoc and VSDoc in JavaScript and TypeScript editors.

The source code available on GitHub

Quote from GitHub README:

DocStubsJs is a fairly straight-forward plugin that uses events and string parsing to determine when and how to insert a document stub. It essentially just watches key-strokes for the identifying documentation ment bock initializers. ("///" for VSDoc, and "/**" for JSDoc) Once it has determined that these have been entered on an empty line, then it parses the lines surrounding it to determine whether to add a new ment line, create a documentation ment stub, or do nothing.

Note:

For JSDoc ments, parameter tags will be added as well as a return tag after typing "/**" on the line above a function header. (Note for Web Essentials users: you may have to disable auto-pletion of multi-line ments in the JavaScript options for Web Essentials in order for this to work.)

本文标签： Generate javadoc for JavaScript in Visual StudioStack Overflow