如何在rdoc中显示行号？-N参数无法实现每行显示行号

1. 如何在rdoc中显示行号？ #

rdoc自带了开启行号显示的参数，你可以用-N（或者它的长格式--line-numbers）来实现。具体操作就是在生成文档时带上这个参数，比如针对单个Ruby源码文件生成带行号的文档：

rdoc -N your_ruby_script.rb

执行这个命令后，生成的HTML文档里，对应的源码代码块就会自动在每行前显示行号了。

2. 使用-N参数后仍无法显示行号，此需求是否可行？ #

这个需求完全是可行的，出现问题大概率是使用场景或配置细节没做好，我之前也碰到过类似的坑，你可以从这几个方向排查：

• 确认目标文件类型：-N参数主要是给Ruby源码文件加行号的，如果你是生成纯注释文档或者非Ruby源码的内容，行号自然不会生效。要确保你是对.rb这类源码文件执行rdoc命令。
• 检查rdoc版本：部分旧版本的rdoc在-N参数的实现上可能存在bug，你可以运行rdoc --version查看当前版本，建议升级到3.x及以上的稳定版试试。
• 模板影响：如果你用了自定义的rdoc模板，可能模板里屏蔽了行号的渲染逻辑。可以先切换回默认模板生成文档，看看行号是否能正常显示。
• 文件范围是否正确：如果是给整个项目生成文档，要确认没有忽略需要显示行号的源码文件，比如检查是否有配置排除了某些文件。

调整好这些细节后，用-N参数就能顺利显示行号了。

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