使用appledoc

作者: 齐滇大圣 | 来源:发表于2015-02-14 17:14 被阅读1528次

安装

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

 git clone git://github.com/tomaz/appledoc.git 
 //打开下载的文件夹
 cd appledoc  
 //开始安装
 sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc  

这样就安装完毕了

然后开始生成文档
命令行输入

appledoc --no-create-docset --output ~/Desktop --project-name jielindoc --project-company ZQD --company-id com.ZQD ~/Desktop/JieLin6/JieLin6/Helpers/

--no-create-docset //不生成docset类型,生成html
--output ~/Desktop //文档生成的位置
--project-name jielindoc //工程的名字,其实这个可以随便取,至少取成工程的名字可以知道这个文档是哪个
--project-company ZQD
--company-id com.ZQD //公司的id
~/Desktop/JieLin6/JieLin6/Helpers/ //你要生成文档的注释类所在的文件目录,及工程目录

(个人感觉:刚开始觉得生成苹果那样的文档好牛逼啊,然后花了点时间自己弄了一下,也生成了文档,但是还是感觉没有直接看代码来的快,如果项目代码框架的写的好的话自己的代码就是一个很好的文档了)

相关文章

  • iOS 生成docset文档

    安装appledoc 使用appledoc生成注释文档 appledoc --output <输出路径> --pr...

  • appledoc

    安装brew install appledoc 使用: appledoc --project-name MyPro...

  • 文档生成工具appledoc

    使用 appledoc 时,只需要用如下命令即可: appledoc -o ./doc --project-nam...

  • 建立iOS专属文档之Objective-C API文档生成器

    appledoc Objective-C API文档生成器 参考文 iOS使用appledoc 生成技术API文档...

  • AppleDoc 导出API文档

    appledoc 支持的注释类型 安装 验证 可以用appledoc --version验证下。 使用 首先cd到...

  • appledoc生成技术API文档

    iOS开发中,可以使用appledoc来生成技术API文档。下面是操作步骤: install appledoc 用...

  • 安装和使用appledoc生成API文档

    安装appledoc 使用终端下载: 直到出现这个画面说明安装成功 使用appledoc 最方便的方法就是在xco...

  • 使用appledoc

    安装 那么简单介绍一下如何安装appledoc,安装非常简单,只需要2步: 这样就安装完毕了 然后开始生成文档命令...

  • appleDoc 使用

    1、先把appledoc 从github上克隆下来,地址 :https://github.com/tomaz/ap...

  • appleDoc使用步骤

    1、下载安装 2、验证是否成功 3、终端cd到根目录中的${SRCROOT}目录下,如图所示。 注意不是跟目录, ...

网友评论

    本文标题:使用appledoc

    本文链接:https://www.haomeiwen.com/subject/jgeexttx.html