appledoc,方便的程序文档编写工具

原创 2015年11月17日 15:57:20

appledoc是自动化文档生成工具,推荐大家使用


它默认生成的文档风格和苹果的官方文档是一致的,安装使用后,可以直接在Xcode中查看。

appledoc 就是用 objective-c 生成的,必要的时候调试和改动也比较方便。

可以生成 docset,并且集成到 Xcode 中。这一点做的非常好,相当于在源码中按住 option 再单击就可以调出相应方法的帮助。

它没有特殊的注释要求,可以用 /** */ 的格式,也可以兼容 /*! */ 的格式的注释,并且生成的注释有汇总页面。

安装


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


1
2
3
 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 .
常用的命令

PATHS

  -o, --output <path>                     Output path

  -t, --templates <path>                  Template files path

      --docset-install-path <path>        DocSet installation path

  -s, --include <path>                    Include static doc(s) at path

  -i, --ignore <path>                     Ignore given path

  -x, --exclude-output <path>             Exclude given path from output

      --index-desc <path>                 File including main index description

PROJECT INFO

  -p, --project-name <string>             Project name

  -v, --project-version <string>          Project version

  -c, --project-company <string>          Project company

      --company-id <string>               Company UTI (i.e. reverse DNS name)

OUTPUT GENERATION

  -h, --create-html                       [b] Create HTML

  -d, --create-docset                     [b] Create documentation set

  -n, --install-docset                    [b] Install documentation set to Xcode

  -u, --publish-docset                    [b] Prepare DocSet for publishing

      --html-anchors <string>             [*] The html anchor format to use in DocSet HTML.

      --clean-output                      [b] Remove contents of output path bef

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

详细的信息可以查看官方的文档:http://gentlebytes.com/appledoc/


版权声明:本文为博主原创文章,如果转载,请注明转载地址和作者

相关文章推荐

epp程序代码文档编写软件

  • 2012年03月14日 15:18
  • 1006KB
  • 下载

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

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

appledoc自动文档生成工具

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

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

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

概要设计文档编写规范

(转自网上) 做软件到一定层次了,就要考虑到设计了,设计了很久,就是不系统,系统的设计需要一个记录,记录就用文档,那么对项目所有包括技术上的设计都记录下来,我们就可以理解为软件的概要设计了。 设...
  • lth93
  • lth93
  • 2015年01月09日 10:18
  • 299

软件开发主要文档编写规范

软件开发主要文档编写规范

《Ruby从入门到精通》文档编写、错误处理、调试和测试 文件和数据库

第八章 文档编写、错误处理、调试和测试 RDoc称自己为“Ruby源代码的文档生成器”,它可以通读Ruby源代码文件,并创建结构化HTML文档。 :nodoc: 让RDoc忽略某个模块、类或方...

《开源框架那点事儿18》:为什么要先从测试用例编写和文档编写开始?

有一个同学,问我一个问题:加入Tiny是否必须从写单元测试用例和文档作起? 此问题引发我诸多感触,故形成乱弹一篇。 作为一个新加入者,多看、少说,是正点。而这个时候,写写测试用例、文档,就是个不...
  • j2eetop
  • j2eetop
  • 2015年06月23日 21:55
  • 297
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:appledoc,方便的程序文档编写工具
举报原因:
原因补充:

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