使用`roxygen2`的内部帮助函数的文档

Question

我对创建自己的程序包不roxygen2并且正在使用roxygen2 。

我正在创建一个包含许多内部帮助器功能的程序包，我想知道是否必须记录所有这些功能。 我了解文档的重要性，但是某些功能相当简单，为方便起见，它们只是包装在其他功能周围。 我已经对网络进行了基本搜索，但是似乎无法找到确切的答案。

任何帮助表示赞赏。

Answer 1

这取决于您“必须”的含义。 一种解释是：“我必须记录这些功能才能通过检查吗？” 这个问题的答案是否定的。 只要不从软件包中导出功能， R CMD check就不需要您对其进行记录。

另一种解释是“我是否必须记录下来以帮助自己维护此软件包？” 这个问题很难回答。 有些功能非常明显，以至于它们实际上不需要名称之外的任何文档，例如，除了通用属性之外，没有其他参数的print方法。

其他功能不太明显，或者具有含义不明显的参数。 如果您打算长期维护软件包，最好将它们记录下来，因为您可能会忘记从现在到出现问题之间的详细信息。 而且，如果您将软件包发布给他人，则应该计划进行长期维护，因为如果有用，人们会使用它。