CODEWITHSUNDEEP
c++visual-studiovisual-studio-2013documentationcomments
user1097772
user1097772

Reputation: 3549

Visual studio 2013 documentation comments

Does Visual Studio have something like a typical IDE to facilitate the entry of documentation comments?

For example, in my Java IDE, when I put the cursor before my function/method and enter /** followed by Enter, the IDE auto-generates a comment template. The comment template includes the arguments for the function/method. I then manually fill in the documentation for each argument.

To further clarify, please consider this function:

function int foo (int id);

Procedure:

  1. Place the cursor on the line just before that function.
  2. Key-in /** and press Enter or something like that. (This works in every Java editor I know.)

Result: 

/**
 * @param id
 * @return
 */

Upvotes: 3

Views: 1292

Answers (3)

QualityPixels
QualityPixels

Reputation: 3

Highlight a block of text and use CTRL+K and CTRL+C to put comments around them. Use CTRL+K and CTRL+U to uncomment. You can also try out the GhostDoc visual studio extension.

Upvotes: 0

Randy Castleberry
Randy Castleberry

Reputation: 56

Triple whack. Put the cursor above a function and type ///.

A comment stub including the parameters is generated in XML, and can be scraped for compiling documentation.

Upvotes: 1

Benjamin W.
Benjamin W.

Reputation: 52441

How about the DoxygenComments extension?

Edit: just saw that it only highlights comments and doesn't create them. Atomineer Pro does that, but it's not free.

Upvotes: 1

Related Questions