如何在 Rails 中为我的模型和控制器生成文档
我想为我的应用程序的模型和控制器创建文档。即使对于 rake 任务，任何后台作业也是如此。由于我在代码之间有数千行内联注释，因此解释了所有函数操作。
我不需要 Rails 文档，所以
rake doc:rails
对我来说毫无用处。
用例是内部详细的开发人员注释。
I want to create docs for the models and controller of my application. Even for rake task, any background job. As I have thousands of lines of comments inline between the code, explanation of the all the functions actions..
I don't want docs for rails so
rake doc:rails
is useless for me.
Usecase is internal detailed developer notes.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
尝试使用此 rake 任务：
此任务由 Rdoc 提供。它还支持一些标记，您可以使用这些标记使格式化时看起来更好。您可以在文档中查看示例。
Try using this rake task:
This task is provided by Rdoc. It also supports some markup that you can use to make things look better when formatted. You can see examples in the documentation.