21、Ruby项目开发与文档编写的最佳实践

Ruby项目开发与文档编写的最佳实践

1. HighLine与termios库

在Unix系统中，如果安装了 termios 库，HighLine会利用它来略微提升字符读取能力，因此建议所有Unix用户安装。如果你使用的是HighLine gem，可以通过以下命令轻松添加 termios ：

$ sudo gem install termios

若要手动安装，请参考 termios 的文档。

当你向用户介绍项目时，需涵盖项目用途、文档位置、简要外观以及安装方法，此外，还应告知他们在遇到问题时如何联系你。例如，对于HighLine，你可以让用户随时通过以下邮箱提问：
- {James Edward Gray II}[mailto:james@grayproductions.net]
- {Gregory Brown}[mailto:gregory.t.brown@gmail.com]

如果项目规模较大，你可以在此处链接到邮件列表或问题跟踪器。

一个好的README文件应简洁明了，主要指向相关信息，而非包含大量具体内容。这样可以降低README过时或无关的可能性。

2. 库文件的布局

2.1 基本结构

Ruby项目的库文件通常存放在 lib/ 目录下，一般该目录包含一个文件和一个子目录。例如，Haml的结构是 lib/haml.rb