23、近乎免费获取文档：Ruby开发中的文档生成与报告创建

近乎免费获取文档：Ruby开发中的文档生成与报告创建

1. 企业应用文档的重要性

企业应用开发成本高昂，很多应用会随着时间推移而逐渐老旧。这些应用通常由多代开发者维护，因此良好的文档至关重要。软件项目文档中最重要的部分是从源代码生成的API文档，以及描述应用所使用数据库结构的图表。这些部分也是最不稳定的，经常会发生变化。现代编程语言都具备自动创建此类文档的机制，Ruby也不例外。

2. 自动生成文档

2.1 问题描述

当完成一个新的Rails应用并准备部署到生产环境时，QA部门通常需要数据库图表来展示应用模型之间的关系，以及API文档来解释所有类及其方法。

2.2 所需工具

• 安装Railroad：用于生成数据库图表的工具。

$ gem install railroad

• 安装Graphviz：用于可视化图形的免费开源工具套件。

2.3 解决方案

假设应用的数据库包含典型的COLA表：customers、orders、line items和accounts。以下是使用ActiveRecord迁移创建这些表的代码：

create_table :customers do |t|
  t.string :forename, :surname
  t.timestamps
end

create_table :accounts do |t|
  t.bel