visual studio - How to document C# projects/assemblies with XML comments and Doxygen? -
i have c# code base xml comments , (owing site) discovered doxygen can generate turn code , comments html , pdf documentation know how document classes , other types , contents.
but how document projects/assemblies/namespaces? code base has on 50 of them; responsibilities must documented.
i'd prefer use xml comments on them well. microsoft's xml commenting manual doesn't give me clue how this, , can't find clues in doxygen documentation either.
what missing? how do provide documentation c# projects/assemblies?
update: know how shfb.
we have been in process of generating documentation our assemblies. have 20- 25 dll's. have used sandcastle [shfb] , been piece of cake. have used following procedure.
- check
xml documentation filein project properties [classlibrary] , provide custom path if required, else xml generated in bin\debug or bin\release folder. - then fire gui sandcastle
- then place pre-requisite dll files in folder , point dlls , xml files in ui , build application. generate chm web pages can use publish in web web help.
googling bit surely give screenshot based sample too..
in case require use doxygen, please refer here
Comments
Post a Comment