如何为R引用类编写文档

  • 本文关键字:文档 引用
  • 更新时间 :
  • 英文 :


我应该如何为R引用类编写文档?我在CRAN上查找"编写R扩展",但我只找到S3和S4对象的指令。

谁能提供一个R ref类及其相关方法的文档示例?

setRefClass的文档解释了这一切,并给出了示例。在方法定义中以字符串形式为方法添加帮助文本:

方法的文档可以通过生成器对象的$help方法获得。类的方法没有以R函数使用的Rd格式文档。相反,$help方法以Python的风格打印方法的调用序列,然后是方法定义中的自我文档。如果方法体的第一个元素是一个字面值字符串(可能是多行),该字符串将被解释为文档。

最新更新