I have a C# code base with XML comments and (owing to this site) discovered that Doxygen can easily generate turn code and comments into HTML and PDF documentation So I know how to document classes and other types and their contents.
But how to document projects/assemblies/namespaces? My code base has over 50 of them; their responsibilities must be documented.
I'd prefer to just use XML comments on them as well. but Microsoft's XML commenting manual doesn't give me a clue how to do this, and I can't find any clues in the Doxygen documentation either.
What am I missing? How do you do provide documentation for your C# projects/assemblies?
Update: I now know how to do it with SHFB.
C can differ quite much from compiler to compiler! @Auron: the specification is the only official documentation; however there are numerous non-official documentations that are much more accessible (both financially and linguistically).
Doxygen (/ˈdɒksidʒən/ DOK-see-jən) is a documentation generator and static analysis tool for software source trees. When used as a documentation generator, Doxygen extracts information from specially-formatted comments within the code.
We too have been in the process of generating the documentation for our assemblies. We have about 20- 25 dll's. We have used Sandcastle [SHFB] and its been a piece of cake. We have used the following procedure.
XML Documentation file
in the Project properties [ClassLibrary] and then provide a custom path if required, else the XML will be generated in the bin\debug or bin\release folder.Googling a bit will surely give you the screenshot based sample too..
In case you require to use only doxygen, please refer here
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With