Question

使用Origen进行测试内容生成时，是否存在记录文本的标准？我在其他例子中看到's'和'cc'以及使用'puts'的地方。

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

Answer 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开关运行Origen时，您将看到输出的调试信息。

您可以在此处详细了解其他日志记录选项：http://origen-sdk.org/origen//guides/misc/logger/?highlight=log

此外，如果您使用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/

记录模式/流/调试文本的标准

1 个答案: