使用Objective-C的文档生成工具:appledoc

转载 2013年12月04日 09:51:00

前言

做项目的人多了,就需要文档了。今天开始尝试写一些项目文档。但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手。象Java语言本身就自带javadoc命令,可以从源码中抽取文档。今天抽空调研了一下objective-c语言的类似工具。

stackoverflow 上找到三个比较popular的工具:doxygen, headdoc和appledoc 。它们分别的官方网址如下:

介绍

我把这3个工具都大概调研了一下,说一下我的感受。

docxygen

docxygen感觉是这3个工具中支持语言最多的,可以配置的地方也比较多。我大概看了一下文档,觉得还是比较复杂,而且默认生成的风格与苹果的风格不一致。就去看后面2个工具的介绍了。另外,它虽然是开源软件,但是没有将源码放到github上让我感觉这个工具的开发活跃度是不是不够。

headerdoc

headerdoc是xcode 自带的文档生成工具。在安装完xcode后,就可以用命令行:headdoc2html + 源文件名 来生成对应的文档。我个人试用了一下,还是比较方便的,不过headerdoc的注释生成规则比较特别,只生成以 /*! */ 的格式的注释。还有一个缺点是每个类文件对应一个注释文件,没有汇总的文件,这点感觉有点不爽。

appledoc

appledoc是在stackoverflow上被大家推荐的一个注释工具。有几个原因造成我比较喜欢它:

  1. 它默认生成的文档风格和苹果的官方文档是一致的,而doxygen需要另外配置。
  2. appledoc就是用objective-c生成的,必要的时候调试和改动也比较方便。
  3. 可以生成docset,并且集成到xcode中。这一点是很赞的,相当于在源码中按住option再单击就可以调出相应方法的帮助。
  4. appledoc源码在github上,而doxygen在svn上。我个人比较偏激地认为比较活跃的开源项目都应该在github上。
  5. 相对于headerdoc,它没有特殊的注释要求,可以用/** */ 的格式,也可以兼容/*! */的格式的注释,并且生成的注释有汇总页面。

安装

那么简单介绍一下如何安装appledoc,安装非常简单,只需要2步:

git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh

使用

使用appledoc时,只需要用如下命令即可:

appledoc -o ./doc --project-name ynote --project-company youdao .

appledoc会扫描当前路径下的所有文件,然后生成好文档放到doc目录下。你也可以用appledoc –help查看所有可用的参数。

基本上使用起来还是比较方便的,详细的信息可以查看官方的文档:http://gentlebytes.com/appledoc/

相关文章推荐

使用Objective-C的文档生成工具:appledoc

前言 做项目的人多了,就需要文档了。今天开始尝试写一些项目文档。但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手。象Java语言本身就自带javadoc命令,可以从源码中抽取文档。...

Objective-C 自动生成文档工具:appledoc 使用

将注释生成文档,在开发中会带来很大的便捷,好处自然你懂得,生成工具很多,appledoc 确实是最好用的,废话不多说,直接上手操作吧! 一、安装过程 第一步:下载安装 git clone git...

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

原文地址:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文...
  • ydj213
  • ydj213
  • 2013年07月24日 10:04
  • 1220

Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具。对于Objective-C来说,目前最好用的工具是appledoc和doxygen。可是这两种工具对于注释的要求略有区别。于是我经...
  • muyu114
  • muyu114
  • 2013年07月24日 17:56
  • 7668

IOS学习笔记-9Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

原文转载地址:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生...

appledoc自动文档生成工具

  • 2015年11月17日 16:01
  • 15.3MB
  • 下载

Objective-C ,ios,iphone开发基础:使用GDataXML解析XML文档,(libxml/tree.h not found 错误解决方案)

使用GDataXML解析XML文档   在IOS平台上进行XML文档的解析有很多种方法,在SDK里面有自带的解析方法,但是大多情况下都倾向于用第三方的库,原因是解析效率更高、使用上更方便   这里主要...

用Doxygen为objective-c代码生成文档

原文见: http://www.dreamingwish.com/dream-2011/use-doxygen-to-generate-documentation-objective-c-code.h...

使用Xcode HeaderDoc和Doxygen文档化你的Objective-C和Swift代码

本文由CocoaChina译者YueWang翻译自AppCoda 原文:Documenting Your Objective-C and Swift Code in Xcode with Heade...

iPhone开发技巧之工具篇(3)--- 使用clang静态解析Objective-C程序

这一回介绍一下 clang,一个用来静态解析程序的工具。clang 是 LLVM 编译器项目中的其中之一。LLVM 支持 C/C++/Objective-C 语言,并有许多 Apple 的工程师加入这...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:使用Objective-C的文档生成工具:appledoc
举报原因:
原因补充:

(最多只允许输入30个字)