使用appledoc生成说明文档

来源:互联网 发布:淘宝云购 编辑:程序博客网 时间:2024/05/17 03:17

粘贴到终端:appledoc --no-create-docset --output ~/Desktop --project-name "JenoTooles" --company-id "jeno.com" --project-company "jeno" /Users/liyongkai/Desktop/ForDream/ForDream/JenoTools


第一步:使用终端命令进行下载安装

git clone git://github.com/tomaz/appledoc.gitcd ./appledocsudo sh install-appledoc.sh说明:--no-create-docset //不生成docset类型,生成html--output ~/Desktop   //文档生成的位置--project-name jielindoc   //工程的名字,其实这个可以随便取,至少取成工程的名字可以知道这个文档是哪个--project-company ZQD--company-id com.ZQD    //公司的id~/Desktop/JieLin6/JieLin6/Helpers/   //你要生成文档的注释类所在的文件目录,及工程目录 appledoc --project-name XXX --project-company "XXX" --company-id XXX --output /tmp/doc./Core  

      appledoc 会扫描当前路径下的所有文件,编译出的Docset默认会放在/Users/ibireme/Library/Developer/Shared/Documentation/DocSets

      路径下。你也可以用 appledoc —help 查看所有可用的参数。其中,XXX 的内容根据具体情况填写,--output 后面接的是文档输出路径,最后一个路

          径,是需要生成文档的源代码所在路径。默认情况,在生成docset文档后,appledoc会把生成的html以及中间文件删除,然后将生 成的docset文档放置到

          xcode搜索的文档路径下。若要保存文档生成过程的中间数据比如生成的html文件,只需在上面的命令中增加以下参数即可。

     --keep-intermediate-files

2. 正确的执行命令:appledoc --no-create-docset --output ~/doc --project-name "Your Project Name" --company-id "com.yourcommpany" --project-company "Your Company"  ./3. appledoc --project-name DiskSizeDemo              --project-company "ray"            --company-id aaaa             --output ./apple~/DeskTop/RYDemoTest/DiskSizeDemo/DiskSizeDemo/doc/        最后一个命令需要5个参数:       1. 工程名字       2. 公司名字       3. 公司ID       4. 生成结果出书路径       5. 扫描那个路径下的类

0 0