You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何在roxygen2中为参数文档添加左对齐子标题?

roxygen2参数分组标题左对齐问题解答

roxygen2原生不支持直接让你写的这种参数分组子标题和参数名称左对齐。因为默认生成的帮助文档里,参数说明区域的文本带有缩进,你用##添加的子标题会继承这个缩进,导致和参数名称无法对齐。

不过可以用两种替代方案实现类似效果:

  • 使用@section标签创建独立分组章节
    这种方式生成的分组标题会和参数名称一样左对齐,示例代码如下:

    #' @param data 输入数据
    #' 
    #' @section 列配置:
    #' @param col_param1 处理列的相关操作
    #' @param col_param2 处理列的其他操作
    #' 
    #' @section 行配置:
    #' @param row_param1 处理行的相关操作
    #' @param row_param2 处理行的其他操作
    

    生成的帮助文档中,每个分组会以独立章节形式呈现,标题左对齐,参数列表对应放在章节下方。

  • 将分组标题标记为特殊“参数”
    用\strong{}包裹分组标题,把它当作一个无实际功能的“参数”来定义,这样标题会和参数名称左对齐,示例:

    #' @param data 输入数据
    #' @param \strong{列配置} 分组说明
    #' @param col_param1 处理列的相关操作
    #' @param col_param2 处理列的其他操作
    #' @param \strong{行配置} 分组说明
    #' @param row_param1 处理行的相关操作
    #' @param row_param2 处理行的其他操作
    

    这种方式的优势是分组标题和参数列表在同一区域内,视觉上更连贯。

内容的提问来源于stack exchange,提问作者Patrick

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.06.13 03:04:59