+- Hack Forums (https://hackforums.net)
+-- Forum: Tech (https://hackforums.net/forumdisplay.php?fid=444)
+--- Forum: Coding (https://hackforums.net/forumdisplay.php?fid=151)
+---- Forum: Software Development (https://hackforums.net/forumdisplay.php?fid=118)
+---- Thread: [C] Visual studio plugins - auto documentation generator? (/showthread.php?tid=5754673)
Visual studio plugins - auto documentation generator? - eskimo1 - Nov 18, 2017
Hello.
I'm a basement dweller coder, so I have never really bothered to write documentation, but now is the time to learn it.
What I am talking about is the nifty XML syntax you can do in Visual studio, looking like this:
/// <summary></summary>
Now, i googled - and there's a million plugins.. All of them seem to be paid, and all of them claim to be the best - what I really want is just the most lightweight solution.
I am aware that it can be done manually, but i'd rather just press a keyboard shortcut and have it autogenerate.
Anyone here using such a plugin? Anyone have one they wanna recommend?
Regards
RE: Visual studio plugins - auto documentation generator? - 0xDEAD10CC - Nov 20, 2017
You write it yourself, not sure why you're looking for plugins to do this... Type 3 "/"s and it will auto-generate the full XML documentation for the function/class/interface/struct/etc... I have never used any plugins and VS has automatically done this for me for quite some time. I typed 3 "/"s and Visual Studio 2017 automatically created this:
![[Image: WowMLqV.png]](https://i.imgur.com/WowMLqV.png)
It's not hard - and inside your project settings you can enable or disable the XML documentation file from being generated... No plugin out there is going to have the AI built in that will actually write out what your function or parameters are intended to do and what the return value is for.
It's really less useful in C++ anyways, and regular comments show up in intellisense:
![[Image: 38GkHEH.png]](https://i.imgur.com/38GkHEH.png)
RE: Visual studio plugins - auto documentation generator? - HFDone - Nov 20, 2017
he ask for c++ as 3 / work just with net
RE: Visual studio plugins - auto documentation generator? - 0xDEAD10CC - Nov 20, 2017
(Nov 20, 2017 01:10 PM)HFDone Wrote: he ask for c++ as 3 / work just with net
I provided my answer to that. XML documentation is not useful IMHO for C++. It's IDE-specific also... I would go with something like: http://www.stack.nl/~dimitri/doxygen/download.html
Asside from that, documentation is time-consuming regardless of how lazy someone is.