462
With the help of “Code2Docu” a documentation is generated from functions (FCs), function blocks (FBs) and PLC data types of a TIA Portal project.
In defined properties and areas, functions (FCs), function blocks (FBs) and PLC data types ( in the following named as “objects”) can be documented using MarkDown (MD) as defined markup language. With “Code2Docu” this information and text elements are extracted from the objects, prepared for the documentation to be generated and stored accordingly.
“Code2Docu” supports the following objects:
- PLC blocks (FC, FB, Safety FC, Safety FB) in the programming languages SCL, STL, FBD, LAD
- PLC data types (UDT, Safety UDT / subordinate structures)
- PLC constants (Global constants)
Benefits of “Code2Docu”
- Reduction of engineering and coordination efforts
- Time savings and thus cost reduction
- Increase of engineering efficiency
- Same “look and feel” for all objects and all documentations, because of template based generation
- Integration in CI/CD Workflows (“Continuous Integration” / “Continuous Delivery”)
- Updateability of the documentation
– Document style
– Change history - “Single point of source”, generation of the entire documentation and the user-defined documentation (user help) from one source
- All documented languages are also stored in the objects as language (multilingual)
- Documentation cannot be “lost” as it is stored together with the project
- Developers can document their code directly –> acceptance criterion for code documentation