Library documentation
You can use comments to document library objects and individual elements of library objects to explain the function and use of the program elements provided by the library.
The documentation created via the comments is displayed as text or as a table in the Library Manager, in which the library is integrated, on the Inputs/Outputs and Library Parameters tabs (description of individual elements of library objects) and in the Documentation tab (general description of library objects). (see Basics)
 | TE1030 | TwinCAT 3 Documentation Generation To improve presentation and gain a larger range of functions in documentation, we recommend using the TE1030 | TwinCAT 3 Documentation Generation tool. |
| Limited support of reStructuredText as of TwinCAT 3.1 Build 4026 The reStructuredText documentation format is available as an alternative to TE1030 | TwinCAT 3 Documentation Generation. Please note that support of this functionality is limited from Build 4026 and is described below. |
Up to and including Build 4024:
- Creation of libraries with reStructuredText documentation as source code (*.library) or compiled library (*.compiled-library)
- Display of the reStructuredText documentation of source code (*.library) or compiled libraries (*.compiled-library)
Build 4026 up to and including version 4026.15:
- No reStructuredText support
Build 4026 from version 4026.16:
- Display of the reStructuredText documentation of compiled libraries (*.compiled-library)
- To create the *.compiled-library with reStructuredText documentation, use a Remote Manager version with Build 4024.
See also: