结构化文本中的文档字符串？

Question

我目前正在使用 Wago 的 e!cockpit 环境在 ST 中编写我的 plc 项目。我知道对于 Python 和 C++，有一些用于文档字符串的程序可以使文档更简单、更清晰。我想知道结构化文本是否有这种东西？或者甚至在 Wago 的 e!cockpit 中？

我还没有找到这样的功能，只是针对更常见的编程语言。

Answer 1

我不太了解 Wago，但我知道新的 e!COCKPIT 是基于 Codesys 3.5 的，如果是这样的话：

可以包含在 IDE 中使用的注释，您可以在此处找到标准化形式的文档（我从未使用它来生成文档，仅作为注释）。

Codesys 3.5 - 图书馆文档

Codesys 3.5 - 库文档 - 格式化命令（概述）

以一种非常简单的方式，如下例所示插入注释将在 IDE 中编程时提供帮助，这适用于任何声明、功能块或变量列表 (

VAR

)：

//This is a FunctionBlock
//Bla bla bla
FUNCTION_BLOCK FB_Test
VAR_INPUT
    MyInput1 : BOOL;  //This is a boolean input (TRUE or FALSE) 
    MyInput2 : INT;   //my grandma asked me to add this input
    MyInput3 : LREAL; //more bla bla bla
END_VAR
VAR_OUTPUT
    MyOutput1 : BOOL; //brrrrrrrr
    MyOutput2 : BOOL; //more bla x 486739^2
END_VAR
VAR
END_VAR