YARD-Cucumber: 一个需求文档工具的技术文档

1. 安装指南

YARD-Cucumber 是一个 YARD 扩展，用于处理 Cucumber 的特性、场景、步骤、标签、步骤定义以及转换，以提供类似于 YARD 显示类、方法和常量的文档。要安装 YARD-Cucumber，需要先安装以下宝石：

• Gherkin 2.2.9
• Cucumber 0.7.5
• YARD 0.8.1

安装 YARD-Cucumber 的命令如下：

$ gem install yard-cucumber

如果是根用户安装，可能需要在前面添加 sudo。

2. 项目的使用说明

YARD-Cucumber 可以自动加载作为插件，你需要在 YARD 配置文件中启用自动加载插件。以下是一个示例：

$ mkdir ~/.yard
$ yard config load_plugins true
$ yardoc 'example/**/*.rb' 'example/**/*.feature'

现在，你可以像平常一样运行 YARD，并捕获你的特性、步骤定义和转换。

3. 项目API使用文档

YARD-Cucumber 的配置可以通过 YARD 配置文件进行自定义。以下是一些可配置的选项：

• 添加或删除搜索字段：通过编辑 ~/.yard/config 文件，可以添加或删除搜索字段。
• 步骤定义语言：在 YARD 配置文件中，可以定义额外的步骤定义，以匹配不同语言的关键字。
• 排除特性或场景：通过在 YARD 配置文件中定义排除标签，可以排除特定的特性或场景。

以下是一个配置示例：

:"yard-cucumber":
  menus: [ 'features', 'directories', 'tags', 'steps', 'step definitions' ]
  language:
    step_definitions: [ 'Given', 'When', 'Then', 'And', 'Soit', 'Etantdonné', 'Lorsque', 'Lorsqu', 'Alors', 'Et' ]
  exclude_tags: [ 'exclude-yardoc', 'also-exclude-yardoc' ]

4. 项目安装方式

除了使用 gem install 命令安装 YARD-Cucumber，你还可以通过 Rake 任务来自动化这个过程。以下是一个 Rake 任务示例：

require 'yard'

YARD::Rake::YardocTask.new do |t|
  t.files   = ['features/**/*.feature', 'features/**/*.rb']
  t.options = ['--any', '--extra', '--opts'] # 可选
end

这样，你就可以通过 Rake 任务来运行 YARD-Cucumber 的文档生成过程了。

以上就是 YARD-Cucumber 的技术文档，它可以帮助用户更好地理解和使用这个强大的需求文档工具。