如何为R引用类编写文档？

Question

我应该如何编写R参考类的文档？我查看＆＃34;写R扩展＆＃34;在CRAN上，但我发现只有S3和S4对象的说明。

任何人都可以提供R ref类及其相关方法的文档示例吗？

Answer 1

documentation for setRefClass解释了所有这些，并举例说明。您可以在方法定义中将方法的帮助文本添加为​​字符串：

  

可以通过生成器对象的$help方法获取方法的文档。类的方法没有记录在用于R函数的Rd格式中。相反，$help方法打印方法的调用序列，然后以Python的方式打印方法定义中的自我文档。如果方法体的第一个元素是文字字符串（可能是多行），则该字符串被解释为文档。