J'ai le Habbit pour commenter des propriétés et des classes avec la documentation XML standard, ce que cela signifie / ce qu'ils font.
Mais dans les classes générées par EF, ils sont tous partis quand je régénère le modèle.
Y a-t-il une autre façon de faire cela?
4 Réponses :
non. Vous devrez modifier votre modèle T4 utilisé pour générer des classes (ou créer un nouvel outil personnalisé pour la génération de classe) pour faire ces commentaires pour vous.
As Ladislav indiqué dans sa réponse, vous devez modifier le modèle T4 afin que les commentaires soient inclus dans le code généré. Cette réponse a été prise de Cet article < / a>: Tout d'abord, vous devez spécifier vos commentaires dans les cases Propriétés du concepteur de modèle. Sous Documentation -> Description longue et résumé. Puis dans le modèle, vous pouvez par exemple ajouter ceci au-dessus de la propriété que vous souhaitez documenter: Cela créera un bloc de résumé au-dessus de votre propriété dans le code généré.
Cela semble bon! Je ne savais pas que vous pouvez modifier le modèle utilisé par EF pour générer du code. Toute indice sur où trouver ces modèles sur disque?
Et je suppose que je dois éditer les modèles sur chaque machine de développeurs? Je ne peux probablement pas dire EF qu'un modèle quelque part dans la solution vs doit être utilisé?
@MICHEL: Si vous cliquez avec le bouton droit de la souris sur la surface designer de l'EDMX, vous pouvez «ajouter un élément de génération de code». Ce fichier vous pouvez modifier à vos besoins. Vous devez également mettre ce fichier sous contrôle source dans le cadre du projet afin qu'il puisse être réutilisé.
Les classes générées EF sont toutes des classes "partielles". Donc, définissez un nouveau fichier avec la même structure de squelette de classe et définissez vos commentaires sur ceux.
Exemple: P>
La classe générée par EF (modèle.designer.cs): p>
/// <summary> Student documentation... </summary>
public partial class Student {}
C'est un très vieux fil, mais il n'était pas immédiatement clair où dans le T4, ce code est inséré. La version du T4 comme de cette écriture suit. Cela met également la ligne à longdes dans la section des remarques, si elle existe.
Code précédent: p> code inséré: p> <#=codeStringGenerator.Property(edmProperty)#>