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 快捷注释,自定义快捷键, 这个没坑,自行探索。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

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