如何记录AngularJS + Ruby on Rails应用程序？

Question

我正在使用码来从rdoc文件生成Rails应用程序的文档.有AngularJS文档生成器,但它们如何连接以生成AngularJS + Rails应用程序的一个连贯文档？

Answer 1

在这种情况下，将它们分开可能很好，而且实际上将它们分开可能更有意义。Angular 将仅用于您的客户端内容，我假设您随后使用 Rails 作为 API，或者可能是应用程序功能的不同部分。无论哪种方式，它们从根本上都在做不同的事情，因此将它们放在不同的文档部分是有意义的。

如果您愿意，您可以为您的文档创建一个“登陆页面”：一个按钮链接到 Angular 文档，一个按钮链接到 Rails 文档，这将解决将它们“放在一个地方”的需要。实际上，想办法让它们在同一个系统中重叠可能并不值得付出努力，而且实际上可能会带来更糟糕的用户体验。