如何在rdoc中仅包含指定的文件或目录？

当然可以直接指定要包含的文件和目录，无需仅依赖排除规则，具体有三种实现方式：

• 命令行直接传入目标路径：运行rdoc命令时，直接将需要生成文档的文件或目录作为参数列出。例如仅处理lib/目录和README.md文件，执行：

  rdoc lib/ README.md
  

  此时RDOC只会扫描你明确指定的内容，不会遍历项目中其他无关文件。

• 使用.document配置文件：在项目根目录创建.document文件，将需要包含的文件、目录路径逐行写入。示例内容：

  lib/
  README.md
  app/models/user.rb
  

  后续直接运行rdoc命令，它会自动读取该文件中的路径，仅处理指定内容。

• 通过Rake任务配置：若使用Rake管理项目，可在Rakefile中配置RDOC任务，明确指定要包含的文件：

  require 'rdoc/task'
  
  RDoc::Task.new do |rdoc|
    rdoc.rdoc_files.include('lib/**/*.rb', 'README.md')
    # 可添加其他配置，如文档标题、输出目录
    rdoc.title = "我的Ruby项目API文档"
    rdoc.rdoc_dir = 'doc/api'
  end
  

  执行rake rdoc即可生成仅包含指定文件的API文档。

需要注意：若同时配置了包含列表和排除规则，包含列表优先级更高，RDOC会先处理指定内容，再用排除规则过滤其中的文件。

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