• 主页
  • 随笔
  • 技术笔记
  • 全部文章
标签 友链 关于我

  • 主页
  • 随笔
  • 技术笔记
  • 全部文章

如何使用appledoc

阅读数:次 2015-09-01
字数统计: 373字   |   阅读时长≈ 1分

安装

那么简单介绍一下如何安装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,加入到Xcode中

方法非常简单,就是直接把已下好的.docset文档拷贝到路径为/Developer/Shared/Documentation/DocSets/ 目录下。

先打开Finder,“前往”,按住alt键,出现资源库,点击进入资源库,然后按照目录放到下面,重启Xcode就好了

  • 本文作者: Grx
  • 本文链接: https://ruixiaoguo.github.io/Grx.github.io/Grx.github.io/2015/09/01/如何使用appledoc/
  • 版权声明: 本博客所有文章除特别声明外,均采用 MIT 许可协议。转载请注明出处!
  • appledoc

扫一扫,分享到微信

Autolayout-VFL语言添加约束
程序员为什么热衷造轮子
  1. 1. 安装
    1. 1.1. 那么简单介绍一下如何安装appledoc,安装非常简单,只需要2步:
    2. 1.2. 然后开始生成文档
      1. 1.2.1. (个人感觉:刚开始觉得生成苹果那样的文档好牛逼啊,然后花了点时间自己弄了一下,也生成了文档,但是还是感觉没有直接看代码来的快,如果项目代码框架的写的好的话自己的代码就是一个很好的文档了)
  2. 2. ios开发中,如何将已下载的帮助文档docset,加入到Xcode中
    1. 2.1. 方法非常简单,就是直接把已下好的.docset文档拷贝到路径为/Developer/Shared/Documentation/DocSets/ 目录下。
    2. 2.2. 先打开Finder,“前往”,按住alt键,出现资源库,点击进入资源库,然后按照目录放到下面,重启Xcode就好了
© 2014-2024 Grx
GitHub:hexo-theme-yilia-plus by Litten
本站总访问量次 | 本站访客数人
  • 标签
  • 友链
  • 关于我

tag:

  • life
  • OC
  • Google
  • Fastlane
  • Flutter
  • hexo
  • 智能家居
  • Apple Watch
  • 逆向
  • Lottie
  • PHP
  • cocos2d
  • Mac
  • MonkeyKing
  • RN
  • Swift
  • RAC
  • WKWebView
  • WebView
  • Xcode
  • xcode
  • ios
  • Android
  • appledoc
  • MMKV
  • LLVM
  • FreamWork






    
    

  • 唐巧的博客
  • 王巍(喵神)OneVsDen
  • 阿里“念纪“
  • 滴滴-戴铭
  • 郭曜源(ibireme)
  • 阿里”南栀倾寒“
  • 蘑菇街李忠
  • 码农人生
  • 玉令天下
  • bang
  • Ian的博客
这里是Grx的个人博客:
iOS开发工程师一枚
联系方式:
QQ:1217255509
Email:grx0917@sina.com
知识管理,时间管理,自我管理,架构即未来
欢迎技术交流!