ruby-on-rails – 如何记录除`README`文件以外的更多文件？

概述我使用 Ruby on Rails 3.1.0和 YARD 0.7.4 gem进行文档编制.我想在生成的文档顶部添加除README文件之外的更多文件,如 here所示(参见README,新增内容,入门指南,体系结构概述,……标签页下方的链接页面顶部) “文件列表”部分). 也就是说,默认情况下,YARD gem似乎只生成与我的RoR应用程序的ROOT目录中存在的README文件相关的文档.我想记录 我使用 Ruby on Rails 3.1.0和 YARD 0.7.4 gem进行文档编制.我想在生成的文档顶部添加除README文件之外的更多文件,如 here所示(参见README,新增内容,入门指南,体系结构概述,……标签页下方的链接页面顶部) “文件列表”部分).

也就是说,默认情况下,YARD gem似乎只生成与我的RoR应用程序的ROOT目录中存在的README文件相关的文档.我想记录其他文件,并为每个文件添加一个选项卡在文档的顶部(如在之前链接的页面中所做的那样).

可能吗？如果是这样,我该怎么做？更多,我应该创建一个新目录(在我的RoR应用程序的ROOT中),其中包含用于文档目的的“自定义”文件吗？

解决方法 阅读 YARD: Command line tool的文档时,您会发现以下内容：

You can also add a .yardopts file to your project directory which Lists the switches separated by whitespace (newlines or space) to pass to yardoc whenever it is run.

上面提示,通过使用 – README liCENSE FAQ,这些文件将被添加到文档中.

.yardopts file for YARD本身包含：

-docs/WhatsNew.mddocs/GettingStarted.mddocs/OvervIEw.mddocs/CodeObjects.mddocs/Tags.mddocs/Parser.mddocs/Handlers.mddocs/Templates.mddocs/Glossary.mdChangeLogliCENSELEgal

我认为这解释了为什么所有这些文件都是文档的一部分.不过,我不知道它们是否可以自动显示.

总结

以上是内存溢出为你收集整理的ruby-on-rails – 如何记录除`README`文件以外的更多文件？全部内容，希望文章能够帮你解决ruby-on-rails – 如何记录除`README`文件以外的更多文件？所遇到的程序开发问题。

如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。