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

DocumentationAssistant

jinyafeng

|
2,046 installs
| (7) | Free
An Extension to generate XML documentation automatically using IntelliSense for interface,class,enum, field, constructor, property and method.

Overview - generate XML documentation automatically using IntelliSense.

short_cut_to_quick_add.gif

Configuration

If your project only needs to document public members. Please set Tools > Options > Documentation Assistant >General > EnableToPublishMembersOnly to True. The setting will be false by default.

Instruction

  1. When you installed it successful 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 shortcut(Alt+Enter or Ctrl+.) to quickly add the documentation.
    short_cut_to_quick_add.gif

Notes

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
  • Terms of use
  • Trademarks
© 2021 Microsoft