Agregar documentación/comentarios XML a las propiedades/campos en las clases generadas por EF

Question

tengo el habito de comentar propiedades y clases con la documentación XML estándar, lo que significa/lo que hacen.

Pero en las clases generadas por EF, por supuesto, estas desaparecieron cuando regeneré el modelo.

¿Hay alguna otra manera de hacerlo?

Answer 1

Como Ladislav indicó en su respuesta, debe modificar la plantilla T4 para que los comentarios se incluyan en el código generado. Esta respuesta fue tomada de this article:

Antes que nada debe especificar sus comentarios en los cuadros de propiedades del diseñador de modelos. En Documentación -> Descripción larga y Resumen.

Luego, en la plantilla, puede por ejemplo añadir este por encima de la propiedad que desea documentar:

<#if (!ReferenceEquals(edmProperty.Documentation, null)) 
{ 
#> 
/// <summary> 
/// <#=edmProperty.Documentation.Summary#> – <#=edmProperty.Documentation.LongDescription#> 
/// </summary> 
<#}#> 

Esto creará un bloque anterior resumen de su propiedad en el código generado.

Answer 2

No. Tendrá que modificar su plantilla T4 utilizada para generar clases (o crear una nueva herramienta personalizada para la generación de clases) para hacer estos comentarios por usted.

Answer 3

Las clases EF generadas son todas clases "parciales". Por lo tanto, defina un nuevo archivo con la misma estructura de esqueleto de clase y defina sus comentarios sobre ellos.

Ejemplo:

La clase generada EF (Model.designer.cs):

public partial class Student : EntityObject {... // bunch of generated code} 

su propio archivo (ModelDocumentation.cs):

/// <summary> Student documentation... </summary> 
public partial class Student {}