appledoc 使用

appledoc 使用brew命令安装使用

appledoc --project-name yushuyi12345677 --project-company "xiaoyu123" --company-id aaaa --output /Users/yushuyi/Desktop /Users/yushuyi/Desktop/MultiFTPTask/MultiFTPTask/Classes 首先可以看 appledoc 使用这篇文章,如果安装不成功提示 -bash:appledoc command not found…

1.安装 git clone git://github.com/tomaz/appledoc.git cd ./appledoc sudo sh install-appledoc.sh 2.使用进入代码所在目录,运行下面代码 appledoc --project-name MyProject --project-company ibireme ./ 也可以在项目中运行脚本,把下面的相关属性改一下,即可 #appledoc Xcode script # Start constants compa…

AppleDoc的安裝使用

前言,還是那句話,新手按照濤叔下面畫黃色的步驟順序執行就好了,不要問為什麼. 一.安裝(注意,濤叔事先已經下載了appledoc) 1.找到下載的appledoc目錄 $ cd /Users/libotao/DevSource/iOS/appledoc 2.運行安裝 $ sudo sh install-appledoc.sh libotaodeMacBook-Pro:~ libotao$ cd /Users/libotao/DevSource/iOS/appledoc libotaodeMacB…

文档生成工具 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…

回归从注释开始 appledoc

好久没有管理这个blog了,些许空虚.不知道今天的回归能否坚持.简单介绍一个第三方注释 -- appledoc appledoc http://gentlebytes.com/appledoc/ 安装过程: 1. git clone git://github.com/tomaz/appledoc.git 2. cd appledoc 3. sudo sh install-appledoc.sh 安装完成.剩下的就是运行. 运行就是一句代码,就是有些啰嗦的一句话: appledoc…

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

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

【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: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…

appledoc导出iOS代码文档的使用和问题详解（干货篇）

appledoc导出iOS代码文档的使用和问题详解(干货篇) 1. 简单说一下背景和自己感受背景: 项目好像突然黄了,公司让详细写项目代码的注释并且导出文档,弄完之后就要封版. 说实话:听到这个消息之后心里还是很担心的,因为我知道公司不可能养闲人,我手上的项目本来年后就没有什么起色,加上突然来了这样的一个'噩耗',顿时就知道后面肯定没好事我知道公司不会养闲人,所以在这几天项目闲下来的日子里,忐忑过,也想到了项目可能面临的种种,当然也包括自己所可能受到的种种影响.但是毕竟我们只是听上面安排的一…

项目管理之使用 appledoc 生成开发文档

写项目时通常会遇到要求写开发文档的需求,但是就源代码来说,文档最好和源码在一起,这样更新起来更加方便和顺手.Objective-C 有一些文档管理工具,doxygen, headdoc 和 appledoc .它们分别的官方网址如下: docxygen http://www.stack.nl/~dimitri/doxygen/index.html headdoc http://developer.apple.com/opensource/tools/headerdoc.html appledoc…

Xcode注释转文档appledoc使用

参考了一些大神的方法总算成功了记录一下少走弯路 1:安装appledoc 使用终端下载: 命令行: git clone git://github.com/tomaz/appledoc.git cd ./appledoc sudo sh install-appledoc.sh 查看是否安装成功: 命令行: appledoc --version appledoc version: 2.2.1 (build 1334) 2 cd 进入工程目录 (目录下的所有文件都会被使用) appledoc --…

技术文档生成工具：appledoc

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

使用appledoc 生成技术API文档具体解释

一. 首先安装 appledoc 第一步:使用终端命令进行下载安装 git clone git://github.com/tomaz/appledoc.git cd ./appledoc sudo sh install-appledoc.sh 上面步骤运行之后.上面三个步骤都是正常运行的.文件有点大,下载会慢一点,我们看下效果图: 成功安装之后的图片假设出现 INSTALL SUCCEEDED 则说明我们成功安装了. 以下进行第二步:安装之后我们进行一个简单的验证 appledoc --ver…

AppleDoc

使用AppleDoc快速生成iOS开发文档 _ 皮卡丘♪-(´ε｀ ) 用 appledoc 生成文档 _ Garan no dou xcode-select_ error_ tool 'xcodebuild' requires Xcode, but active developer directory '_Library_Developer_CommandLineTools' is a command line tools instance · Issue #569 · nodejs_node…

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

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

VVDocument+Appledoc生成文档

在写代码的时候写上适当的注释是一种良好的习惯,方便自己或者别人阅读的方便. **VVDocument**:(Github地址:[VVDocument](https://github.com/onevcat/VVDocumenter-Xcode)) 下载该项目,用Xcode运行一下即可.插件生成的位置在 /Users/Simple/Library/Application Support/Developer/Shared/Xcode/Plug-ins 目录下面.关闭并重启Xocde后即可使插件生效.…

【appledoc 使用】的更多相关文章