iOS - 代码注释 与 文档

代码注释插件：https://github.com/onevcat/VVDocumenter-Xcode
输出文档：https://github.com/tomaz/appledoc

注：需要使用下面格式的注释才行

/*!
 *  字符串拼接
 *
 *  @param aString 需要拼接的字符串
 *
 *  @return 新的字符串
 */
- (NSString *)stringByAppendingString:(NSString *)aString;


或者


/*! 名字 */
@property (nonatomic, copy) NSString *name;

安装 文档输出工具

• 1 下载 appledoc

https://github.com/tomaz/appledoc

• 2 前往文件夹

cd /Users/juyiwei/Desktop/appledoc-master 

• 3 安装

$ sudo sh install-appledoc.sh 

以后可以愉快的使用

• 1 先cd 到 项目路径

cd /Users/juyiwei/Desktop/appledocTest

• 2 输出

// 简写
appledoc -p XXXX -c "YYYY" --company-id ZZZZ -o ~/doc  ./

注：
XXXX：项目名称
YYYY：公司名称：主要体现在：Copyright © 2016 YYYY. All rights reserved. Updated: 2016-04-14
ZZZZ：公司ID：例如com.apple

注2：
文档存放位置：~/Library/Developer/Shared/Documentation/DocSets
生成的文档名称：ZZZZ.XXXX.docset
显示包内容进去找到index 的网页进入文档主页。

注 命令说明

appledoc --project-name myproject111 --project-company "surgeyohoo" --company-id www.surge --output ~/doc  ./Appledoc

命令说明：
--project-name "项目名称"
--project-company "公司名称"
--company-id "工程ID"
--output "生成路径（亲测无效，是我使用方式不对？）"
./Appledoc  "扫描路径"

1