通过代码注释生成API文档
我正在使用aglio来生成我的API文档。 我目前正在根据API蓝图规范为此编写原始降价。 我想知道是否有一种方法可以直接在代码中通过注释生成降价。 有谁知道有一种方法来做到这一点？
技术上这是可能的。 取决于你的语言和使用的框架。 例如，在Ruby中，可以使用RSpec来生成API蓝图 。
我不熟悉任何类似于Node.js的工具（例如使用Express.js DSL）。
在编写生成蓝图的工具时，可以避免手动编写蓝图，而使用Matter Compiler 。 该工具（Ruby gem）将JSON或内存树（AST）转换为API蓝图。
请注意，我个人build议反对从代码中生成文档。 相反，我将API Blueprint视为可用于testingAPI实现的合同。
从这个意义上说，从代码生成蓝图就像从代码生成testing（以testing相同的代码）。
我不知道agilo，但其他替代解决scheme是使用maven站点插件生成API文档。
<plugin> <artifactId>maven-site-plugin</artifactId> <groupId>org.apache.maven.plugins</groupId> <version>${maven-site-plugin.version}</version> <configuration> <locales>en,fr</locales> </configuration> </plugin> 您可以编写包含API详细信息的apt文件，之后您可以运行maven来生成文档。 它生成漂亮的文档。 这是非常受欢迎的，很多人在工业上广泛使用。
更多详情，请参阅http://maven.apache.org/plugins/maven-site-plugin/examples/creating-content.html