如何让YARD忽略项目中的README.template.md文件？

问题根源 #

YARD的--exclude参数基于正则表达式匹配文件，此前的写法未精准锁定目标文件；另外@private标记仅对Ruby代码元素生效，无法让YARD跳过Markdown文件的解析。

有效解决办法 #

1. 命令行精准正则排除 #

执行YARD文档生成命令时，使用精准正则匹配文件名（注意转义.，防止匹配任意字符）：

yard doc --exclude README\.template\.md$

若shell对正则解析有干扰，可将规则用引号包裹：

yard doc --exclude 'README\.template\.md$'

2. 写入.yardopts实现永久排除 #

在项目根目录的.yardopts文件中添加排除规则，确保每次执行YARD都会自动忽略该文件：

--exclude README\.template\.md$
--exclude _pb.rb$
--no-private

3. 全局配置忽略（可选） #

若需全局生效，可在YARD全局配置文件（~/.yard/config）或项目本地.yardrc中添加：

ignore:
  - README\.template\.md$

但更推荐用.yardopts，方便团队共享配置。

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