rdoc使用疑问:call-seq块风格写法如何保留缩进格式?
可行解决方案
- 方案1:使用硬空格(Unicode U+00A0)填充缩进
将example1、example2行前需要保留的普通空格替换为U+00A0类型的硬空格即可,rdoc的call-seq解析逻辑不会裁剪这类特殊空格,会原样保留缩进效果,生成的文档完全符合预期,也不会触发代码块的高亮反色样式。大部分编辑器都支持直接输入硬空格:macOS下按Option+空格,Windows下按Alt+0160即可输入。 - 方案2:自定义rdoc解析逻辑跳过缩进裁剪
如果不想依赖特殊字符,可以在项目的rdoc生成配置(比如Rakefile、.rdoc_options配置文件)中添加少量扩展代码,重写call-seq块的缩进处理逻辑,跳过对块内前导空格的自动裁剪:
RDoc::Markup::ToHtml.class_eval do alias :original_handle_call_seq :handle_call_seq def handle_call_seq node node.parts.each do |part| next unless part.is_a? RDoc::Markup::Raw # 保留所有前导空格,不做自动裁剪 part.text = part.text.gsub(/^ /, ' ') if part.text end original_handle_call_seq node end end
该修改仅作用于call-seq块的渲染逻辑,不会干扰rdoc的其他功能。
- 方案3:折中的文本标记方案
如果上述两种方案都不适用,可以在call-seq的块内行前加>标记实现类似缩进的视觉效果,rdoc不会移除这类标记后的空格,展示上也能清晰区分块内代码和方法签名。
内容的提问来源于stack exchange,提问作者David Ljung Madison Stellar
相关产品推荐
相关产品推荐

