首页 > 移动平台 > 详细

文档生成工具 appledoc

时间:2014-02-16 23:29:49      阅读:656      评论:0      收藏:0      [点我收藏+]

参考文章

1、安装:

$ git clone git://github.com/tomaz/appledoc.git
$ cd appledoc
$ sudo sh install-appledoc.sh

 

2、注释添加规则:

bubuko.com,布布扣
1)多行注释 
/** 
  多行注释  (/* 不会被捉取 */)
*/

2) 单行注释
//// 单行注释  
// 不会被捉取

3) 
  @brief 简要说明
  @param 参数说明 @param name description
  @return 返回值说明
  @exception 描述 exception

4)对于同一个方法不能出现两个或两个以上地方的文档注释,否则.h文件里的注释会覆盖了.m文件
bubuko.com,布布扣

 

3、使用

bubuko.com,布布扣

$ appledoc --project-name TestDoc --project-company "xxxxx-inc" --company-id com.xxxxx-inc.TestDoc .

bubuko.com,布布扣

  注意:

    a) 该命令只扫描当前目录下的所有文件。

    b) 生成 .docSet 文件于 "/Users/xxx/Library/Developer/Shared/Documentation/DocSets/com.eileen.testdoc.testDoc.docset"

bubuko.com,布布扣

bubuko.com,布布扣

 

4、帮助

$ appledoc --help

文档生成工具 appledoc

原文:http://www.cnblogs.com/eileenleung/p/3551370.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!