Search code examples
c#documentationcode-generation

Documenting auto-generated code

I use code-generation for my data access layer and Doxygen for documentation. My problem is that I can't add Xml comments on the generated classes since they will be overwritten as soon as I re-generate the code. To be more precise I can add Xml comments to my custom methods (which are in a separate file as partial classes) but I can't do it on data properties.

Any suggestions?

Solution

  • With Doxygen, you don't have to write your documentation scattered throughout the file, so you can keep it separate from the generated code and prepend it to the generated file as a post-generation step.