Appledoc - Source Documents

Link : GitHub官网

从源码中抽取出文档的工具!

特点

  • 默认生成的文档风格和苹果的官方文档一致。
  • Appledoc 使用 Objective-C 编写,可以对源代码进行调试和改动。
  • 生成 docset,并且集成到 Xcode 中。按住 Option 并点击相应 API 可以直接调出帮助文档。

安装步骤

  • 使用终端命令进行安装(下载速度比较慢,建议去 Github 上下载)
git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh
  • 进入工程项目根目录中
 cd projectPath
  • 执行 appledoc 命令
appledoc --project-name projectname 
         --project-company companyname 
         --company-id com.companyname #可选
         --output pathWithDocsetPathText #可选,docset-installed.txt,文本里面含有 docset 的路径,默认路径是 ~/Library/Developer/Shared/Documentation/DocSets 
         inputFilePath #必要,导入到文档中的所在文件路径,使用 . 默认是当前路径

其他命令:appledoc --version 查看版本,appledoc --help 帮助命令。
若不想生成 docset ,在 appledoc 后面加 --no-create-docset。

  • 执行完成后前往 docset 路径右键打开 companyid.projectname.docset 显示包内容,Contents -> Resources -> Documents 打开 index.html 便可查看文档内容。
  • 重启 Xcode 也能在 Help -> Documentation and API Reference下看到生成的文档。

将运行脚本集成到工程中

  • 在工程中新建 New -> File -> Target
  • 新建 Other -> Aggretage 命名 Documents
  • 进入该 target 的设置界面 Build Phases -> 点击添加按钮 -> 添加 Run Script
  • 设置脚本为上面 appledoc 命令,需要额外添加 --exit-threshold 2 参数,不然运行时会报以下报错:
Command /bin/sh failed with exit code 1

完成上述设置之后,以后需要更新文档,直接运行 aggretage 即可。

源代码

代码需要添加一定格式的注释才能在文档中显示,使用 CMD + Option + / 添加注释即可满足需求。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 因为要结局swift3.0中引用snapKit的问题,看到一篇介绍Xcode8,swift3变化的文章,觉得很详细...
    uniapp阅读 4,537评论 0 12
  • 前言 本篇文章主要讲解如何使用不同的工具来生成HTML注释文档 , 对于注释的使用和说明你可以在注释使用这篇文章得...
    与伟大LEE同行阅读 2,504评论 2 5
  • 1.Xcode IDE概览 说明:从左到右,依次是“导航窗格(Navigator)->边列(Gutter)->焦点...
    小地阅读 5,391评论 0 9
  • Ubuntu的发音 Ubuntu,源于非洲祖鲁人和科萨人的语言,发作 oo-boon-too 的音。了解发音是有意...
    萤火虫de梦阅读 99,589评论 9 467
  • linux资料总章2.1 1.0写的不好抱歉 但是2.0已经改了很多 但是错误还是无法避免 以后资料会慢慢更新 大...
    数据革命阅读 12,239评论 2 33