C# Code Generation

Question

Estoy buscando crear un pequeño generador de clases para un proyecto. He estado leyendo sobre CodeDOM por lo que la semántica de crear las clases no parece ser un problema, pero no estoy seguro de cómo integrar mejor la generación en el proceso de desarrollo e implementación.

1. ¿Cómo debo activar la creación de las clases? He leído que debería ser parte del proceso de compilación, ¿cómo debo hacer esto?

2. ¿Dónde deberían crearse las clases? Leí que los archivos no deben editarse a mano, y nunca deben verificarse en el control de fuente. ¿Debo preocuparme por esto y simplemente generar las clases en el mismo directorio que el motor del generador?

Answer 1

Las respuestas a su pregunta dependen en parte del objetivo de las clases generadas.

Si las clases se generan como parte del desarrollo , deben generarse como archivos de texto y registrarse en su SCM como cualquier otra clase.

Si sus clases se generan dinámicamente en runtime como parte del funcionamiento de su sistema, no utilizaría CodeDOM en absoluto. Yo usaría Reflection.

Answer 2

Eche un vistazo a las plantillas T4 (está incorporada en VS2008). Le permite crear clases de "plantilla" que generan código para usted. Oleg Sych es un recurso invaluable para esto.

Link for Oleg's tutorial on code generation.

Answer 3

Sé de la presencia de plantillas T4 (y sé que mucha gente las usa), pero no las he usado yo mismo. Aparte de eso, tiene dos opciones principales:

1. Use un SingleFileGenerator para transformar la fuente directamente dentro del proyecto. Siempre que guarde el documento que edita, automáticamente regenerará el archivo de código. Si usa el control de fuente, el archivo generado se registrará como parte del proyecto. Existen algunas limitaciones con esto:
   • Solo puede generar una salida para cada entrada.
   • Dado que no puede controlar el orden en que se generan los archivos, y los archivos no se generan en el momento de la compilación, su salida solo se puede derivar efectivamente de un solo archivo de entrada.
   • El generador de archivos único debe instalarse en la máquina del desarrollador si planea editar el archivo de entrada. Como el código generado está en control de fuente, si no editan la entrada, entonces no necesitarán regenerar la salida.
   • Como la salida se genera solo cuando se guarda la entrada, la salida no debe depender de ningún estado que no sea el contenido exacto del archivo de entrada (incluso el reloj del sistema).
2. Generar código como parte de la compilación. Para esto, escribe un archivo de objetivos MSBuild. Para esto, tiene control total de entrada (s) y salida (s) para que las dependencias puedan ser manejadas. El estado del sistema se puede tratar como una dependencia de entrada cuando sea necesario, pero recuerde que cada compilación que requiere generación de código lleva más tiempo que una compilación que usa un resultado generado anteriormente.Los resultados (archivos fuente generados) generalmente se colocan en el directorio obj y se agregan a la lista de entradas que van al csc (el compilador C#). Limitaciones de este método:
   • Es más difícil escribir un archivo de objetivos que un SingleFileGenerator.
   • La construcción depende de generar la salida, independientemente de si el usuario va a editar la entrada.
   • Como el código generado no es parte del proyecto, es un poco más difícil ver el código generado para cosas como establecer puntos de interrupción.