如何记录引用类的成员函数的使用?
如果我写一个Rd
文件带有\usage
阻塞,我该如何避免WARNING
Functions/methods with usage in documentation object 'XmlDoc' but not in code:
$ new
我期望的是\usage
阻止允许我写这样的东西:
obj <- ClassName$new(par1, par2, ...)
obj$method1(oth1, ...)
然后我将参数记录在\arguments
block.
如果我这样做,R CMD check
抱怨
Assignments in \usage in documentation object 'ClassName':
并且不将这些方法识别为我需要文档的代码对象。
截至目前,我正在写Rd
没有的文件\usage
块并将上面的代码写入\examples
块,但是我没有地方记录参数,这样check
实际上几乎没有什么需要检查的。由于我对此不满意,我现在向社区询问当前的常见做法。
我不知道这是否是正确的方法,但我所做的是Methods部分,然后将方法文档放在内部describe.
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)