记录自动生成的代码

Question

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?

Answer 1

使用Doxygen， 您不必编写分散在整个文件中的文档 ，因此您可以将其与生成的代码分开，并在生成后的步骤中将其添加到生成的文件中。

Answer 2

Keep the documentation in your model, and have your CST templates pull out & write that information to the generated code.

For example, you can comment (is comment the right word? Maybe the field is called summary) tables and columns in your SQL database - i know of a few codegen solutions that automatically put that text into your code...