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/


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

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

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

iOS appledoc自动生成API文档

iOS 自动生成API文档
  • L_weiguo
  • L_weiguo
  • 2017年06月07日 10:32
  • 337

初识DocBook(编写技术文档的工具)

突然在Linux下看到一堆命令
  • xuyunzhang
  • xuyunzhang
  • 2014年05月29日 14:22
  • 1990

gitbook--好用的编写API文档工具

参考资料:http://gitbook.zhangjikai.com/index.html创建一个gitbook仓库包含基本的文件:.gitignore SUMMARY.md(撰写左边导航栏) R...
  • lintcgirl
  • lintcgirl
  • 2017年01月10日 15:09
  • 5007

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

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

告别手写 API文档生成工具推荐

随着API的发展以及需求的日益增加,对API文本文档的需求与随之而来。相信许多开发人员都遇到过编写API文档方面的问题及烦恼。 你是否还通过手写的方式来生成和编写这些文档呢?那么你就OUT啦!话说工...
  • u011537073
  • u011537073
  • 2017年04月26日 22:38
  • 2547

在线API文档、技术文档工具ShowDoc

【个人开源作品】在线API文档、技术文档工具ShowDoc ShowDoc是什么 每当接手一个他...
  • Im_so_nervous
  • Im_so_nervous
  • 2016年11月18日 13:17
  • 1693

【推荐】apidoc api文档生成工具的使用(mac)

apidoc
  • cl61917380
  • cl61917380
  • 2016年05月29日 12:18
  • 3522

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

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

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

前言 做项目的人多了,就需要文档了。今天开始尝试写一些项目文档。但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手。象 Java 语言本身就自带 javadoc 命令,可以从源码中...
  • zrhloveswallow
  • zrhloveswallow
  • 2015年10月29日 11:02
  • 257
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:appledoc,方便的程序文档编写工具
举报原因:
原因补充:

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