2

使用 Origen 生成测试内容时，在实践中是否有记录文本的标准？我在其他示例中看到了“ss”和“cc”以及使用“puts”的地方。

应该进入 Origen 生成的测试模式和流程元素的注释、应该在生成期间打印的注释以及应该只在调试打开时打印的注释的正确用法是什么？

4

1 回答 1

1

除了临时调试外，一般puts不应该使用。Origen 应用程序中的约定是保持日志记录尽可能轻，这是对这个领域的许多工具的反应，这些工具的日志记录过于冗长，以至于用户大多会忽略它。

因此，仅当您认为这样做非常重要时才登录到终端：

Origen.log.info "Something important to tell the user!"

大多数情况下，如果信息仅用于调试目的，则使用：

Origen.log.debug "Some debug help, the value of X is: #{x}"

-d在这种情况下，终端输出将是干净的，但是当您使用switch 开关运行 Origen 时，您会看到正在输出的调试信息-verbose。

您可以在此处阅读有关其他日志记录选项的更多信息：http: //origen-sdk.org/origen//guides/misc/logger

此外，如果您使用 Origen 生成模式，则cc和ss方法可用。

cc "A low level comment"

将以这样的模式出现：

// A low level comment

对于模式中的主要步骤，您可以使用ss：

ss "A high level comment"

这看起来会更加强调，像这样：

//####################################################################
//# A high level comment
//####################################################################

对于多行步骤注释，您可以使用此 API：

step_comment do
  cc "We are about to do this:"
  cc "  Blah: blah"
  cc "  Blah: blah"
end

看起来像：

//####################################################################
//# We are about to do this:
//#   Blah: blah
//#   Blah: blah
//####################################################################

您可以在此处阅读有关如何记录模式的更多信息：http: //origen-sdk.org/origen/guides/pattern/documenting/

于 2017-09-06T15:51:12.067 回答