r - Roxygen 真的可以像 Doxygen 对 C++ 那样记录 R 脚本(不是包)吗?

标签 r documentation doxygen roxygen

Roxygen 的灵感来自 C、C++ 程序员使用的 Doxygen 文档系统。我使用过 Doxygen,我发现只要你有 doxygen 注释,就可以很容易地记录任何程序。它还为函数和类生成调用图。我认为 roxygen 会以同样的方式工作,但是当我搜索 roxygen 帮助时,我只能找到记录 R 包的解决方案。

我在网上查了 Hadley Wickham 的 roxygen2 help但这并没有描述关于 R 脚本文档的任何内容。

我的脚本有时会变成 500-1000 行,并且有几个我总是用注释记录的函数。我想用图形可视化图表生成 PDF 或 HTML 文档。 Roxygen 是否能够制作调用图和文档独立的 R 脚本?

最佳答案

不,roxygen2仅适用于编写包文档。在我看来,您正在寻找报告生成工具。您可以使用 knitr为了那个原因。您可以包含代码、注释、文本、MathJax,甚至可以使用 LaTeX。它还支持目录和引用文献。这绝不是一个详尽的功能列表。由于一些逻辑限制,您可以生成 pdf 和 html 文档等。

关于r - Roxygen 真的可以像 Doxygen 对 C++ 那样记录 R 脚本(不是包)吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/37338044/

相关文章:

r - 将 texreg 或 stargazer R 中的模型显示格式设置为科学

documentation - 什么是自文档化代码?它可以取代有据可查的代码吗?

c# - 我在哪里可以找到 C# 3 的深入指南?

doxygen - 如何摆脱 doxygen 中空的相关页面选项卡?

r - 某些 R 包不会使用 update.packages() 进行更新

r - ggplot2:如何在使用 scale_xx_manual 后创建正确的图例

r - 尝试在 R 中运行 kNN 时,我收到由 coercionNAs 引入的错误 NAs?

Xcode 4 文档引用?

java - 混合 java/scala 项目的自动生成文档

c++ - 如何让 DOxygen 使用和识别注释掉的参数名称?