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

转载 2015年07月09日 00:43:13

前言

做项目的人多了,就需要文档了。今天开始尝试写一些项目文档。但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手。象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步:

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

使用

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

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

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

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

转自:http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/

开源框架:Appledoc——Objective-C文档生成工具使用教程

appledoc是命令行工具,帮助Objective-C 开发者从格式化的源码注释生成像苹果官方风格的文档,并且可以生成可以在Xcode查看的docset文件。本文将介绍appledoc安装使用,以及...
  • xiaozhi6156
  • xiaozhi6156
  • 2015年03月27日 13:24
  • 667

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

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

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

http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/ 前言 做项目的人多了,就需要...
  • leonpengweicn
  • leonpengweicn
  • 2013年09月16日 15:11
  • 673

iOS使用appledoc 生成技术API文档详解

转自:http://www.jianshu.com/p/65f1afdb9445 一、 首先安装 appledoc 第一步:使用终端命令进行下载安装 git clone git://...
  • Jason_chen13
  • Jason_chen13
  • 2017年06月05日 10:28
  • 508

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

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

用appledoc生成文档

由 ibireme 发表于 2013/08/26 Intro 接触过java的童鞋们一定知道javadoc这种东西,写好代码、码上注释,然后用javadoc一跑,一包html的文档就生...
  • mad2man
  • mad2man
  • 2014年04月26日 10:06
  • 3273

终于可以用appledoc生成html格式的doc文档了

上周五就在捣鼓这个了。已经从github下载了appledoc的源代码,也设置好路径。查看是否设置好可以使用which appledoc,安装好应该是在/usr/local/bin/appledoc里...
  • wtichnana
  • wtichnana
  • 2014年04月01日 15:05
  • 3701

appledoc, Objective-C的文档生成工具

还没有机会实践,先记录下来吧,有机会试用一下。 原帖地址: http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode...
  • simpson910
  • simpson910
  • 2013年07月01日 14:04
  • 836

appledoc文档生成工具

前言在移动开发的今天,为了多项目进行开发,需要编写一些项目文档。对于开发者而言,项目源码和文档最好是放在一起,这样更新源码与项目时都会更将方便。 java语言本身自带了javadoc命令,可以从源码...
  • yayayaya20122012
  • yayayaya20122012
  • 2016年01月28日 13:41
  • 305

Xcode配置Appledoc并生成项目文档

安装Appledoc 首先说下Appledoc的地址 https://github.com/tomaz/appledoc 这里有Appledoc的最新信息。 安装Appledoc很简单...
  • xcysuccess3
  • xcysuccess3
  • 2014年05月21日 22:55
  • 3944
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:使用Objective-C的文档生成工具:appledoc
举报原因:
原因补充:

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