Entity Framework : Documentación de código generado

Documentar nuestro código es una buena práctica reconocida que ayuda a la legibilidad y mantenimiento en nuestros desarrollos. De todos es conocido la tag Summary para documentar las cabeceras de nuestras clases, métodos, etc.

 Bien, si modelamos una clase con en Entity Framework, el código generado posee una tag con un comentario como el siguiente:

image

 Pero esto tiene fácil arreglo, si nos vamos al diseñador de nuestro modelo, en la pestaña de Propiedades, seleccionando la propiedad Age del ejemplo anterior, tendremos el siguiente apartado:

image

 Que podremos rellenar con el texto que deseamos que aparezca en la cabecera de esta propiedad y, por tanto, en nuesto IntelliSense o nuestro proyecto de documentación generado, por ejemplo, con la herramienta Sandcastle

 Una vez recompilado nuestro proyecto, el código generado será el siguiente:

image

 

 Y ya en tiempo de codificación:

image

 Espero que este pequeño consejo os ayude a la documentación en tiempo de desarrollo de vuestro código cuando utilicéis Entity Framework 🙂

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *