可以使用什么工具来生成Xcode项目的文档? [英] What tools might I use for generating documentation for an Xcode project?

查看:163
本文介绍了可以使用什么工具来生成Xcode项目的文档?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

我想知道Xcode中可以使用哪个工具来生成iPhone项目的文档,大部分都是以C-C和C语言编写的,而且还有助于设计代码。
我想要生成的文档是:




  • 类似UML的类图(具有泛化,聚合和组合关系)

  • 类似UML的组件图

  • 类似UML的序列图



我知道两个不错的工具:Doxygen(我在Xcode中使用的不是)HeaderDoc(它看起来类似于Doxygen,但并没有集成在Graphite中的甜心图生成工具)。但是这些是自动化工具,并以文件/类为中心。
任何其他有用工具的建议?



更新:
如果还不清楚(哈哈,我看到标题更改了),我想生成文档,但不仅仅是从一个(xcode)项目而是for:例如规划如何构建其架构并使用组件/配置图进行设计。我希望找到一些与IDE完美集成的东西(像Eclipse中看到的大量插件)<​​/ p>

解决方案

自从你对Doxygen很舒适,它具有您需要的功能,坚持下去。请参阅Apple的从Doxygen项目生成Xcode文档集的指南 CorePlot 项目是在Xcode项目中使用 Doxygen。


I am wondering which tool can be used in Xcode to generate the documentation for an iPhone project, so written in objective-C and C mostly, but also helping designing the code. The documents I'd like to be produced are:

  • UML-like class diagrams (with generalization, aggregation and composition relationships)
  • UML-like components diagram
  • UML-like sequence diagram

I know two nice tools: Doxygen (which I used not inside Xcode) a HeaderDoc (which seems similar to Doxygen but does not integrates the sweet graph generation facilities that comes with GraphViz in DoxyGen). But those are automated tools and are file/class centric. Any suggestion on some other useful tool?

UPDATE: If it is still not clear (lol, I saw the title change again), I'd like to generate the documentation but not only 'from' an (xcode) project but also 'for': for instance planning how to structure its architecture and design it using a components/configuration diagram. I hope to find somthing that integrates well with the IDE (something like the multitude of plugins you see for Eclipse)

解决方案

Since you're comfortable with Doxygen and it has the features you need, stick with that. See Apple's guide on producing Xcode documentation sets from Doxygen projects. The CorePlot project is a good example of using Doxygen in an Xcode project.

这篇关于可以使用什么工具来生成Xcode项目的文档?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆