Search code examples
c#xamarinxamarin-studiovisual-studio-mac

Auto generate all inline XML documentation for a C# project


I have a project with over 100 C# classes and want to generate the documentation for every variable, property and method. In the Visual Studio macOS IDE you can do this for 1 method at a time with /// , but this is monkey work to do this for all classes.

Is there a possibility to automate this in Xamarin Studio/Visual Studio for Mac? If not, is there an IDE where I can do this?

I don't want a program that bundles the documentation (like Doxygen), I want something that adds the inline documentation, I will add the documentation myself (or edit the autogenerated documentation).


Solution

  • You can do this with GhostDoc or SandCastle. Sandcastle is a standalone app that will run over the source in your project folder, while Ghostdoc is a plugin for Visual Studio.

    Sadly, neither work on mac.