安装appledoc,简单的方法就是
- )下载源码 git clone git://github.com/tomaz/appledoc.git
-
)安装appledoc,并且安装到/usr/bin等目录下,以便直接appledoc直接运行。
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application\ Support/appledoc
生成文档
通过下面的命令去生成文档
appledoc --project-name WXMessengerDoc --project-company "alibaba-inc" --company-id com.alibaba-inc.WXMessenger [--output ./helloworld] [includeFilePathOrFile] [--ignore excludeFilePathOrFile] .
这个命令只扫描当前目录下所有文件(另外包含includeFilePathOrFile和去除excludeFilePathOrFile) 并生成到某个目录下(默认是当前目录)
该命令结束后会添加到系统的文档目录下
If the path is directory, it's recursively parsed for all source files. If path is file, it's parsed as source file
更多关于命令的说明是这样的:
http://gentlebytes.com/appledoc-docs-examples-basic/
通过以下命令来生成API文档
- appledoc --project-name yushuyi12345677
- --project-company "xiaoyu123"
- --company-id aaaa
- --output /Users/yushuyi/Desktop
- /Users/yushuyi/Desktop/MultiFTPTask/MultiFTPTask/Classes
1:工程名称
2:公司名称
3:工程ID
4:生成结果输出路径
5:扫描哪个路径下的类.
该命令会根据指定的路径将所有的的类遍历一次,当生成成功以后,appledoc会新建一个文本文件来记录生成情况,这个文件存放在上面命令中指定的--output.
执行上面的命令时,请确保删去了所有的换行符以后在执行.
生成的文档会自动存放在Xcode默认的文档目录里:
~/Library/Developer/Shared/Documentation/DocSets
不出意外的话,进入到目录里面就可以看到刚刚执行命令以后生成的文档:
我们都知道按住option键位时,再点击某个方法或者属性名称