是否有允许包含图表和图像的 Ruby 文档工具?
我是 doxygen 的忠实粉丝,多年来我一直在各种语言中使用它。 特别是,我很欣赏它类似 wiki 的能力,包含图像并运行Graphviz 点生成器具有来自 内联 DOT 代码 或 外部文件。
RDoc 支持使用 Graphviz 生成类图,但我看不到任何包含任意图像或图表的方法。 它似乎也不支持像氧气一样建立任意页面。
是否有任何工具可以为 Ruby 提供这些 Doxygen 风格的功能?
我浏览了 Ruby Toolbox 工具列表,它们似乎都是 RDoc 的变体。
目前对我来说最有可能的解决方案似乎是扩展Yard。
I am a big fan of doxygen which I have used for years with various languages. In particular, I appreciate its wiki-like ability to include images and run the Graphviz dot generator to have arbitrary inline diagrams from inline DOT code or external files.
RDoc has diagramming support to generate class diagrams using Graphviz but I can't see any way to include arbitrary images or diagrams. Neither does it appear to support building up arbitrary pages like oxygen.
Is there any tool which provides these Doxygen-style features for Ruby?
I have skimmed the Ruby Toolbox list of tools and they all seem to be variants of RDoc.
The most likely solution for me at present seems to be extending Yard.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
RDoc 会自动将 url 转换为 html 链接,指向图像文件的 url 会自动转换为 html 图像。
RDoc will automatically convert urls to html links and urls which point to image files are automatically converted to html images.
正如我上周在 珀斯敏捷聚会 上得知的那样,graphviz 集成现在可以作为yard的一个分支。
As I was told at a Perth Agile Meetup last week, graphviz integration is now available as a branch of yard.