TIA Portal Add-In "Code2Docu" para la generación de documentación
Con la ayuda del Add-In "Code2Docu", la documentación se genera a partir de las funciones (FCs), los bloques de función (FBs) y los tipos de datos del PLC de un proyecto de Siemens TIA Portal.
En las propiedades y zonas definidas, las funciones (FC), los bloques de funciones (FB) y los tipos de datos del PLC (en adelante denominados "objetos") pueden documentarse utilizando _MarkDown_ (MD) como lenguaje de señalización definido. Con ayuda del Add-In "Code2Docu", esta información y los elementos de texto se extraen de los objetos, se preparan para crear la documentación y se guardan en consecuencia.
"Code2Docu" soporta los siguientes objetos:
- Bloques de PLC (FC, FB, Safety FC, Safety FB) en los lenguajes de programación SCL, AWL, FUP y KOP
- Tipos de datos del PLC (UDT, Safety UDT / Estructuras inferiores)
- Constantes de PLC (constantes globales)
Ventajas del "Code2Docu"
- Reducción de los esfuerzos de ingeniería y coordinación
- Ahorro de tiempo y, por tanto, reducción de costes
- Aumento de la eficiencia de la ingeniería
- El mismo aspecto para todos los objetos y toda la documentación, ya que la generación está basada en plantillas
- La integración en flujos de trabajo CI/CD ("Integración continua" / "Entrega continua")
- Capacidad de actualización de la documentación
. Estilo en el documento
. Historial de modificaciones
- "Single point of source", Generación de toda la documentación y de la documentación definida por el usuario (ayuda al usuario) a partir de una sola fuente
- Todos los idiomas documentados se guardan también en los objetos como idiomas (multidioma).
- La documentación no se puede "perder", ya que se guarda junto con el proyecto
- Los desarrolladores pueden documentar su código directamente --> Criterio de aceptación de la documentación del código