机器人框架中的多行文档答案

【问题标题】：Multiline Documentation in robot framework机器人框架中的多行文档
【发布时间】：2013-04-11 11:21:53
【问题描述】：

我想在机器人测试用例本身中记录测试场景、场景背后的原理等。为此，文档需要支持多行功能和格式。无论如何，是否可以包含某些格式的文档，例如rst，这样我就可以通过简单的语法获得更多的格式化能力。

【问题讨论】：

标签： automated-tests functional-testing restructuredtext robotframework

【解决方案1】：

您可以将文档分布在多行中，并且机器人支持一些简单的标记。有关它支持的特定标记的信息，请参阅robotframework users guide 中的Documentation formatting。

我的团队使用竖线分隔的格式，我们将文档分布如下：

| Test Case 1
| | [Documentation]
| | ... | = Example Heading =
| | ... | *bold* _italic_ 
| | ... | Lorem ipsum dolor sit amet, consectetur adipisicing elit,
| | ... | do eiusmod tempor incididunt ut labore et dolore sed magna
| | ... | aliqua. Ut enim ad minim veniam, quis nostrud exercitation 
| | ... | ullamco laboris nisi ut aliquip ex ea commodo consequat.

【讨论】：

您还可以有多个[Documentation] 行，它们会自动附加到上一行。
@MarkHu since robot >=2.9 这已被弃用Invalid syntax in test case 'My test': Setting '[Documentation]' used multiple times.

【解决方案2】：

Robot Framework user guide 经历了编写文档的不同方式。还有testdoc-tool 用于根据测试用例生成高级文档。

【讨论】：