Auto generate all inline XML documentation for a C# project

Question

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

So you need somethig that would generate empty summary tags for you? — MaLiN2223
– MaLiN2223, Commented Feb 23, 2017 at 13:55
GhostDoc could do the trick: 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
– Caspar Kleijne, Commented Feb 23, 2017 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
– Robin Bruneel, Commented Feb 23, 2017 at 14:01
Did you try to search for similar problems? Check for answers in e.g. this question. — Sinatr
– Sinatr, Commented Feb 23, 2017 at 14:12
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
– Damien_The_Unbeliever, Commented Feb 23, 2017 at 14:26

vrwim · Accepted Answer · 2017-02-23 14:19:15Z

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.

answered Feb 23, 2017 at 14:19

vrwim

14.6k13 gold badges68 silver badges124 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

albert · Accepted Answer · 2018-12-23 10:41:00Z

0

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

edited Dec 23, 2018 at 10:41

albert

9,2003 gold badges24 silver badges42 bronze badges

answered Feb 23, 2017 at 15:18

Archiman

1,0802 gold badges10 silver badges24 bronze badges

3 Comments

Damien_The_Unbeliever Over a year ago

From the Question: "I don't want a program that bundles the documentation (like Doxygen),..."

Archiman Over a year ago

ok sorry, I suggest it because I used it and I found it perfect.

Manthan Over a year ago

How to generate todo list in xamarin?

Collectives™ on Stack Overflow

Auto generate all inline XML documentation for a C# project

2 Answers 2

Comments

3 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related