Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Create html documentation for C# code [closed]

I'm currently working on a C# project and VisualAssist generates these fancy /// <summary></summary> comments for me and I've been using them do document my code.

I assume there must be a way to use these comments to create HTML documentation like those done by Doxygen or Javadoc. How do I do that?

like image 918
jaho Avatar asked Mar 09 '13 21:03

jaho


People also ask

What is Doxygen in C?

Doxygen is the de facto standard tool for generating documentation from annotated C++ sources, but it also supports other popular programming languages such as C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, and to some extent D.

Does C# have documentation?

C# provides a mechanism for programmers to document their code using a comment syntax that contains XML text.


1 Answers

Doxygen or Sandcastle help file builder are the primary tools that will extract XML documentation into HTML (and other forms) of external documentation.

Note that you can combine these documentation exporters with documentation generators - as you've discovered, Resharper has some rudimentary helpers, but there are also much more advanced tools to do this specific task, such as GhostDoc (for C#/VB code with XML documentation) or my addin Atomineer Pro Documentation (for C#, C++/CLI, C++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, Unrealscript code containing XML, Doxygen, JavaDoc or Qt documentation).

like image 178
Jason Williams Avatar answered Oct 06 '22 14:10

Jason Williams