iOS-注释-关于注释

参考文档

appledoc:http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html
Alcatraz:http://www.tuicool.com/articles/Vffumym
Alcatraz 安装之后可以用它安装VVDocumenter,参考地址:https://github.com/onevcat/VVDocumenter-Xcode
解决xcode升级插件不可用: http://www.tuicool.com/articles/Ybamaa

  1. 生成docset
      对于最新版本的appledoc来说,它默认时是生成docset文档并集成到xcode。在终端中使用cd命令进入项目的文件夹,然后执行下列命令:
appledoc --output ./doc --project-name objcdoc --project-company "abc" --company-id "cn.com.abc" .

output ./doc:设置输出目录为“./doc”。
--project-name objcdoc:设置项目名为“objcdoc”。
--project-company "abc":设置公司名为“abc”。
--company-id "cn.com.abc":设置公司id为“cn.com.abc”。
. :表示当前目录。

如果要生成html格式:

appledoc --no-create-docset --output ./doc --project-name objcdoc --project-company "abc" --company-id "cn.com.abc" .

但是这些都是在当前项目文件夹下执行,如果想改变生成目录,就用绝对目录:cd – 这个命令,可以查看绝对路径。

设置生成注释文档在桌面的temp文件夹下:

appledoc --no-create-docset --output /users/yourUserName/Desktop/temp/doc/projectName --project-name projectName --project-company “abc” --company-id “com.abc” .

appledoc :

  1. 安装appledoc之后,在usr/local/bin 你要有bin这个目录的读写权限。
  2. 可以生成指定目录下的代码的注释,方法是:在指定目录下执行appledoc命令。
  3. 严格按照要求进行注释,格式一定要对齐,如:
/**
 * @brief -100~100,负值表示自右向左,正值表示自左向右。
 *  @warning zhuyi.
 */
  1. 生成类别:
///-------------------------------------------------
/// @name Project values handling
///-------------------------------------------------
zhushi.png

安装 VVDocumenter 快捷注释,自定义快捷键, 这个没坑,自行探索。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,968评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,601评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,220评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,416评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,425评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,144评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,432评论 3 401
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,088评论 0 261
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,586评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,028评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,137评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,783评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,343评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,333评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,559评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,595评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,901评论 2 345

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,601评论 18 139
  • 一.首先需要安装appleDoc,有两种方法操作: 1.直接从github上下载下来: gitclonegit:/...
    海阔天空_栋阅读 1,094评论 0 1
  • ****一、Xcode 插件下载:**** VVDocumenter下载: https://github.com/...
    _浅墨_阅读 2,450评论 0 2
  • 前言 本篇文章主要讲解如何使用不同的工具来生成HTML注释文档 , 对于注释的使用和说明你可以在注释使用这篇文章得...
    与伟大LEE同行阅读 2,444评论 2 5
  • ~叔本华的人生智慧(经典语录笔记) 1、人不会为事物所左右,但会被他们对于事物的思维所左右。 2、幸福是需要时得到...
    乾小龙阅读 262评论 0 0