R包帮助文档中有序列表无法显示数字的问题求助

兄弟，我太懂你这种折腾roxygen列表显示的糟心了！之前我也踩过这个坑，给你分享几个最有效的解决办法：

1. 先确认开启roxygen的Markdown支持 #

这是最容易忽略的关键一步！roxygen2默认不启用Markdown解析，你写的数字列表会被当成普通文本或无序列表处理。

修改包根目录下的DESCRIPTION文件，添加或修改以下字段：

Roxygen: list(markdown = TRUE)

如果你的DESCRIPTION里已有Roxygen字段，比如原内容是Roxygen: list(roclets = c("rd", "collate", "namespace"))，把它改成：

Roxygen: list(roclets = c("rd", "collate", "namespace"), markdown = TRUE)

2. 检查roxygen注释里的有序列表格式 #

确保你的列表写法完全符合Markdown规范：

• 每一行开头是阿拉伯数字 + 英文句号 + 空格，比如1. 第一步操作，别用中文句号，也别漏了空格
• 列表前后要和其他文本空出一行，避免和上下文混在一起，示例写法：

#' @title 测试函数
#' @description 这个函数用于演示有序列表的正确写法：
#'
#' 使用步骤：
#' 1. 准备符合要求的输入数据
#' 2. 调用test_func()函数并传入参数
#' 3. 解析函数返回的结果
#' @export
test_func <- function() {
  # 函数内容
}

3. 正确重新生成帮助文档 #

别只依赖Build & Reload，建议按这个流程操作：

1. 先运行devtools::document(clean = TRUE)，这个参数会强制清理旧的rd文件，重新生成新的
2. 然后运行devtools::load_all()加载最新的包
3. 再调用?test_func查看帮助文档，应该就能看到带数字的有序列表了

4. 确保roxygen2版本足够新 #

如果控制台提示Markdown相关的版本警告，说明你的roxygen2版本太老了，赶紧升级：

install.packages("roxygen2")

或者安装最新的开发版：

devtools::install_github("r-lib/roxygen2")

内容的提问来源于stack exchange，提问作者matsuo_basho