Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Is there a good alternative to xml documentation comments for C#?

I find the xml doc comments for C# or VB.NET very hard to read. Is there a decent alternative (that still provides the benefits of documenting code for intellisense, doc generation, etc.)?

like image 876
Pete Avatar asked Nov 14 '22 14:11

Pete


1 Answers

If readability is the problem you're trying to solve (i.e. reading XML is making your eyes wobble, which it does mine) you could add a stylesheet to the xml comments file. I started with the one referenced in this old post and modified from there. You'll have to add it back every time you build, but when you're documenting your changes for later reference (i.e. not using the docs a lot during active development) then it's not too bad.

I also use GhostDoc to make documentation a little less time-consuming.

like image 63
cori Avatar answered Dec 27 '22 19:12

cori