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

【Objective-C规范注释心得——同时兼容appledoc（docset、html）与doxygen（html、pdf）的文档生成】的更多相关文章

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

作者:zyl910 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具.对于Objective-C来说,目前最好用的工具是appledoc和doxygen.可是这两种工具对于注释的要求略有区别.于是我经过一番摸索,找到了一套能同时兼容这两种工具的注释写法. 工具简介——appledoc:简单方便,适于生成apple风格的html文档,及直接集成到xcode帮助(docset).官网 http://gentlebytes.com/appledoc/ .doxygen:功能强大,适…

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

使用Objective-C的文档生成工具:appledoc 前言做项目的人多了,就需要文档了.今天开始尝试写一些项目文档.但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.象 Java 语言本身就自带 javadoc 命令,可以从源码中抽取文档.今天抽空调研了一下 objective-c 语言的类似工具. 从 stackoverflow 上找到三个比较 popular 的工具:doxygen, headdoc 和 appledoc .它们分别的官方网址如下: docxygen…

【原创】利用doxygen来管理项目文档或注释

一.doxygen应用场景: doxygen可以用来管理目前主流的编程语言的注释而形成文档系统.(包括C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran等).doxygen官网地址(http://www.doxygen.nl/)近来大部分时间花在api接口的维护上面,其中比较重要的一个环节就是你写的接口如何让调用者一目了然的理解用法.不管是内部无线服务端与客户端之间的配合,还是对外开放的API接口,都一样.花了几…

appledoc:Objective-C注释文档生成工具

appledoc是帮助Objective-C开发者从特殊格式的源代码注释中生成类似apple资源代码帮助文档的命令行工具. 安装和使用都非常简单: 安装 git clone git://github.com/tomaz/appledoc.git cd appledoc sudo sh install-appledoc.sh 使用在终端中使用cd命令进入项目的文件夹,然后执行下列命令: appledoc --output ./doc --project-name SD4iPhone --pr…

【iOS】objective-c 文档生成工具 appledoc

最近做ios framework的一些测试,提供给其他开发者使用的framework,API文档变得更加重要,以前没有接触过,这次尝试使用了一把appledoc来生成一下文档,感觉还不错. 首先,是从这个哥们儿的文章里面发现大家推荐使用appledoc http://blog.devtang.com/blog/2012/02/01/use-appledoc-to-generate-xcode-doc/ 下面介绍一下appledoc的基本使用. 1 — 安装 git clone git://git…

技术文档生成工具：appledoc

做项目一般都会要求写技术文档,特别是提供SDK或者基础组件的.如果手写这类技术文档的话,工作量比编写代码也少不了多少.比如 Java 语言本身就自带 javadoc 命令,可以从源码中抽取文档.本篇我们看一下OC中的一个类似工具:appledoc. 1.简介基于命令行的操作.使用方便,默认生成的文档风格和苹果的官方文档是一致的,即docset,集成到xcode中就跟苹果的官方文档一模一样,在源码中按住option再单击就可以调出相应方法的帮助,当然也可以生成html文档. 总结一下,它具有下面…

文档生成工具 appledoc

参考文章 1.安装: $ git clone git://github.com/tomaz/appledoc.git $ cd appledoc $ sudo sh install-appledoc.sh 2.注释添加规则: )多行注释 /** 多行注释 (/* 不会被捉取 */)*/ 2) 单行注释//// 单行注释 // 不会被捉取 3) @brief 简要说明 @param 参数说明 @param name description @return 返回值说明 @exception 描述 e…