使用 roxygen2 的内部辅助函数文档
Documentation of internal helper function using `roxygen2`
我刚开始创建自己的包，我正在使用 roxygen2。
我正在创建一个包含大量内部辅助函数的程序包，我想知道是否必须记录所有这些函数。我理解文档的重要性，但有些功能相当简单，只是为了方便而对其他功能进行包装。我已经对网络进行了基本搜索，但我似乎无法找到明确的答案。
感谢任何帮助。
这取决于你所说的 "have to" 是什么意思。一种解释是，"Do I have to document these functions to pass checks?" 该问题的答案是否定的。只要函数不是从包中导出的，R CMD check 就不需要您记录它。
另一种解释是"Do I have to document it to help myself in maintaining this package?"这个问题更难回答。有些功能非常明显，除了它们的名称之外，它们实际上不需要任何文档，例如一个 print 方法，除了泛型之外没有额外的参数。
其他函数不是很明显，或者参数的含义不是很明显。如果您打算长期维护您的包，最好将这些记录下来，因为您可能会忘记从现在到出现问题时的细节。如果你要将你的包发布给其他人，你应该计划长期维护，因为如果它有用，人们就会使用它。
我刚开始创建自己的包，我正在使用 roxygen2。
我正在创建一个包含大量内部辅助函数的程序包，我想知道是否必须记录所有这些函数。我理解文档的重要性，但有些功能相当简单，只是为了方便而对其他功能进行包装。我已经对网络进行了基本搜索，但我似乎无法找到明确的答案。
感谢任何帮助。
这取决于你所说的 "have to" 是什么意思。一种解释是，"Do I have to document these functions to pass checks?" 该问题的答案是否定的。只要函数不是从包中导出的，R CMD check 就不需要您记录它。
另一种解释是"Do I have to document it to help myself in maintaining this package?"这个问题更难回答。有些功能非常明显，除了它们的名称之外，它们实际上不需要任何文档，例如一个 print 方法，除了泛型之外没有额外的参数。
其他函数不是很明显，或者参数的含义不是很明显。如果您打算长期维护您的包，最好将这些记录下来，因为您可能会忘记从现在到出现问题时的细节。如果你要将你的包发布给其他人，你应该计划长期维护，因为如果它有用，人们就会使用它。