Documenter le code généré automatiquement

Question

J'utilise la génération de code pour ma couche d'accès aux données et Doxygen pour la documentation. Mon problème est que je ne peux pas ajouter de commentaires Xml sur les classes générées car elles seront écrasées dès que je recréerai le code. Pour être plus précis, je peux ajouter des commentaires Xml à mes méthodes personnalisées (qui sont dans un fichier séparé en tant que classes partielles) mais je ne peux pas le faire sur les propriétés de données.

Des suggestions?

Answer 1

Avec Doxygen, you don't have to write your documentation scattered throughout the file, vous pouvez le garder séparé du code généré et le préfixer au fichier généré en tant qu'étape post-génération.

Answer 2

Conservez la documentation dans votre modèle et faites sortir vos modèles CST. & écrivez cette information dans le code généré. Par exemple, vous pouvez commenter (est-ce que commenter le bon mot? Peut-être que le champ s'appelle résumé) les tables et les colonnes dans votre base de données SQL - je connais quelques solutions de codegen qui mettent automatiquement ce texte dans votre code ...