Robot 框架中的多行注释

Question

有没有办法在Robot框架中注释多行。

在Python中我们有像'''和''''这样的选项。

Answer 1

没有区块评论功能。然而，您可以使用一个微妙的小技巧来注释掉整个块。它没有记录为多行注释功能，但可以这样使用。

这个技巧的工作原理是知道机器人将忽略表中不属于四个可识别表之一的任何数据：关键字、测试、设置或变量。如果您还有其他表格，则其下直到下一张表格的所有内容都将被忽略。

用户指南的相关部分这样说：

2.1.4 解析数据的规则

忽略数据

Robot Framework 解析测试数据时，会忽略：

• 第一个不以可识别的表名开头的所有表 细胞。
• ...

例如：

*** Test Cases *** 
| test 1 
| | log | this is test one

*** comment ***
| test 2
| | log | this is test two

*** Test Cases ***
| test 3
| | log | this is test three

如果运行上述测试，您将看到仅执行测试 1 和测试 3。 “评论”表中的所有内容都将被忽略。

Answer 2

不可以，您必须在要评论的每一行前面使用

#

。

但请注意：

• 如果您使用纯文本格式文件，则第一部分（设置、变量或测试用例）之前的整个测试都是自由文本，您不必对其进行注释。
• 一些 IDE 提出了一次性注释多行的快捷方式，例如 PyCharm 的 Ctrl+/（或 Command+/，如果您使用的是 Mac）。

Answer 3

理想情况下，如果您想注释一行Robot代码，请将光标放在该行上并按ctrl+/，它将从该行的开头注释该行。喜欢：

#<<Your Code lines here>>

如果您想在该行或关键字前面指定特定的机器人行或关键字的作用，只需键入 # 并输入您的评论。例如：

Click &{Locator}  #This keyword clicks on the locator specified.

此外，您还可以选择编写测试用例的文档。例如：如果您的测试用例都是关于验证登录肯定场景，那么您可以将文档编写为：

Test case name
    [Tags]  Valid_credentials
    [Documentation]  This test case validates Login functionality with valid credentials.
    Your keywords or variable declaration will start here
    .....
    .....
    finish your test case

希望这个简单的提示有所帮助。

Answer 4

对于那些想要注释大量行的人来说，另一个技巧是使用

ctrl + /

。这将注释掉光标所在的行或突出显示的任何行。然后，您可以突出显示这些行并再次使用

ctrl + /

取消注释它们。

Answer 5

要注释和取消注释，请使用 Ctrl+?选择多行后。

Answer 6

从 Robot Framework 3.1 开始，有一个专门的部分/表格

*** Comments ***

评论：附加评论或数据。被机器人框架忽略。

引入这一点是因为，从 3.1 开始，无法识别的部分/表会导致错误。 有关更多信息，请参阅 https://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#test-data-syntax

Answer 7

我们可以使用

#

来注释掉多行代码。 您可以简单使用

ctrl + /

Answer 8

我刚刚发现你可以像这样进行多行注释：

*** Test Cases ***

test1

   ${var1}   Set Variable  someVariable

   Comment   This is a comment
   ...       with multiple
   ...       lines.

• 对我有用。我正在使用 Robot Framework 4.1.2（达尔文上的 Python 3.8.2）

Answer 9

添加一个部分***评论***并在下面放置您想要评论的所有行

Answer 10

多行注释步骤：

1. 选择需要的线路
2. 使用 Control+\ 快捷键