roxygen2包文档中的逐字输出

Question

8

我正在使用RStudio中的roxygen2生成软件包文档。如何强制在@description部分中出现等宽固定字体？

SettingID    Value    
RedItem      Patient_10574    
GreenItem    Record_433

我的解决方法是将其放入@examples \ dontrun {}中，但这不是我想要的。

@Joshua Ulrich在这里找到了一个（非）解决方案。

- Dieter Menne

一个想法，\code{}怎么样？它能处理多行吗？ - Roman Luštrik

显然，\code{}是我的首选，但我无法让它遵守verbatim布局。我以为我可以使用\dontrun{}，但这个命令在@examples之外不被接受。也许我错过了一些技巧，但我尝试了几种“换行符”变体。 - Dieter Menne

1

这可能是我在这里遇到的同样问题。 - Joshua Ulrich

你是对的，我记得曾经读过那个，但是没有联系起来。 - Dieter Menne

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- krlmlr · Accepted Answer

更新: roxygen2 现在默认关闭换行，因此这不再是一个问题。

我为 roxygen2 发明了一种新的注释语法，可以保留换行: 以以下内容开头的注释。

#''

这里的文本没有任何换行。我的参考实现尚未得到很多关注...

当然，完全关闭换行也是解决问题的一种方式，但我想知道，如果开发人员忘记在她的roxygen注释中使用换行符，那么在命令行终端中帮助文档会是什么样子... 换行符为什么会被引入，肯定有原因。