Skip to content
| Marketplace
Sign in
Visual Studio>Tools>DocumentationAssistant
DocumentationAssistant

DocumentationAssistant

jinyafeng

|
8,598 installs
| (11) | Free
An Extension to generate XML documentation automatically using IntelliSense for interface,class,enum, field, constructor, property and method.
Download

Overview - generate XML documentation automatically using IntelliSense.

short_cut_to_quick_add.gif

Note

If your project only needs to document public members. You can use the same Extension (DocumentationAssistantPublicMembersOnly) but only it is enabled for public members. Please make sure you don't install the two extensions both or else the second will be not working

Asking help

From feedback, I can get the extension is working similar with GhostDoc. There are some features that are very good. Such as

  • Applying the fix by using a keystroke. A nice default would be: CTRL-SHIFT-D
  • Support selecting a file and automatically adding XML comments
  • Provide a option page to enable/disable non-public members to be documented. So the DocumentationAssistantPublicMembersOnly version can be retired.

Sincerely thanks if anyone can help.

Instruction

  1. When you installed it successfully to your Visual Studio. You can see the warning wave line below the members which don't have documentation on it.
    warning_wave_line.gif

  2. Then you can click the bulb to see the fix option. When you click the option, the documentation will be added.
    quick_action_options.gif

  3. You can use a shortcut(Alt+Enter or Ctrl+.) to quickly add the documentation.
    short_cut_to_quick_add.gif

Last but not the least

It can help you generate general documentation according to the member identifier.
Please add additional information if you think it is not good.
Hope it can save your time and make you focus on code.

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft