4

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).

vrwim
  • 13,020
  • 13
  • 63
  • 118
Robin Bruneel
  • 1,063
  • 8
  • 22
  • So you need somethig that would generate empty summary tags for you? – MaLiN2223 Feb 23 '17 at 13:55
  • 1
    GhostDoc could do the trick: http://submain.com/products/ghostdoc.aspx However, it can only generate comments derived from the information in the code. That makes it pretty usesless if you don't upgrade it with useful information – Caspar Kleijne Feb 23 '17 at 13:55
  • @MaLiN2223 Visual studio for mac does not generate empty tags. It gives a generated summary and a summary of every paramater of your method. – Robin Bruneel Feb 23 '17 at 14:01
  • Did you try to search for similar problems? Check for answers in e.g. [this question](http://stackoverflow.com/q/429452/1997232). – Sinatr Feb 23 '17 at 14:12
  • 2
    The problem with auto-generating the documentation comments is it's then difficult to keep track of which ones are currently useless (just auto-generated) vs the ones that are useful (have real documentation attached). Your one chance to know this for sure is to *not* auto-generate them. – Damien_The_Unbeliever Feb 23 '17 at 14:26
  • I'm not quite sure I get your point. You have to document all types and members anyway, so your overhead is typing `///` per documented entity. Generated documentation comments, as Damien notes, are utterly useless, so you'd have to go over each and every documentation comment anyway. Three keystrokes is fairly negligible compared to the effort of actually _writing_ documentation, I think. But if you're just after generating an empty summary for everything, then that's probably half an hour of effort to do with Roslyn. – Joey Feb 23 '17 at 15:23
  • How to generate todo list in xamarin? – Manthan Mar 28 '18 at 11:14

2 Answers2

2

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.

vrwim
  • 13,020
  • 13
  • 63
  • 118
0

I use doxygen for C# documentation, it works for Xamarin too.

albert
  • 8,285
  • 3
  • 19
  • 32
Anas EL HAJJAJI
  • 1,048
  • 2
  • 10
  • 22