Ich habe die Gewohnheit, Eigenschaften und Klassen mit der Standard-XML-Dokumentation zu kommentieren, was es bedeutet / was sie tun.
Aber in EF generierten Klassen sind das natürlich alle weg, wenn ich das Modell neu generiere.
Gibt es einen anderen Weg, dies zu tun?
Wie Ladislav in seiner Antwort gesagt hat, müssen Sie die T4-Vorlage ändern, damit die Kommentare in den generierten Code aufgenommen werden. Diese Antwort stammt aus diesem Artikel :
Zunächst müssen Sie Ihre Kommentare in den Eigenschaftenfeldern des Modelldesigners angeben. Unter Dokumentation - & gt; Lange Beschreibung und Zusammenfassung.
Dann können Sie in der Vorlage beispielsweise über der Eigenschaft, die Sie dokumentieren möchten, Folgendes hinzufügen:
%Vor%Dadurch wird im generierten Code ein Übersichtsblock über Ihrer Eigenschaft erstellt.
Nein. Sie müssen Ihre T4-Vorlage ändern, die zum Generieren von Klassen verwendet wird (oder ein neues benutzerdefiniertes Tool für die Klassengenerierung erstellen), um diese Kommentare für Sie zu erstellen.
Die EF generierten Klassen sind alle "partiellen" Klassen. Definieren Sie also eine neue Datei mit der gleichen Skelettstruktur der Klasse und definieren Sie Ihre Kommentare zu diesen.
Beispiel:
Die von EF generierte Klasse (Model.designer.cs):
%Vor%Ihre eigene Datei (ModelDocumentation.cs):
%Vor%Tags und Links c# entity-framework documentation