用Xcode自带headerdoc生成API文档

Xcode生成API文档
生成文档有三种方式,官方支持的headerdoc,第三方的appledoc,doxygen
headerdoc的好处
官方的支持option+左键,xcode更新不需要额外操作
headerdoc标签
二级标签
@brief: 使用它来写一段你正在文档化的method, property, class, file, struct, 或enum的短描述信息。

@discussion: 用它来写一段详尽的描述。如果需要你可以添加换行。

@param: 通过它你可以描述一个 method 或 function的参数信息。你可以使用多个这种标签。

@return: 用它来制定一个 method 或 function的返回值。

@see: 用它来指明其他相关的 method 或 function。你可以使用多个这种标签。

@sa: 同前一条类似。

@code: 使用这个标签,你可以在文档当中嵌入代码段。当在Help Inspector当中查看文档时,代码通过在一个特别的盒子中用一种不同的字体来展示。始终记住在写的代码结尾处使用@endcode标签。

@remark:在写文档时,用它来强调任何关于代码的特殊之处。

一级标签
@file: 使用这个标签来指出你正在记录一个文件(header 文件或不是)。如果你将使用Doxygen来输出文档,那么你最好在这个标签后面紧接着写上文件名字。它是一个top level 标签。

@header: 跟上面的类似,但是是在 HeaderDoc中使用。当你不使用 Doxygen时,不要使用上面的标签。

@author:用它来写下这个文件的创建者信息

@copyright: 添加版权信息

@version: 用它来写下这个文件的当前版本。如果在工程生命周期中版本信息有影响时这会很重要。

@class: 用它来指定一个class的注释文档块的开头。它是一个top level标签,在它后面应该给出class名字。

@interface: 同上

@protocol: 同上两个一样,只是针对protocols

@superclass: 当前class的superclass

@classdesign: 用这个标签来指出你为当前class使用的任何特殊设计模式(例如,你可以提到这个class是不是单例模式或者类似其它的模式)。

@coclass: 与当前class合作的另外一个class的名字。

@helps: 当前class帮助的class的名字。

@helper: 帮助当前class的class名字。

headerdoc生成API命令
terminal定位到包含工程的根目录
headerdoc2html -o /Users/admin/Desktop/changeMethod/doc /Users/admin/Desktop/changeMethod

http://www.cnblogs.com/Twisted-Fate/p/4829417.html
https://shengpan.net/headerdoc/

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,886评论 18 139
  • 前言 在一个应用的整个开发过程中涉及到了无数的步骤。其中一些是应用的说明 , 图片的创作 , 应用的实现 , 和实...
    与伟大LEE同行阅读 3,980评论 3 6
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 1,767评论 0 9
  • 我就驻立在青草之上 用一年的清晨与夜星 等着 你沿石径缓缓走来 你拿着一束纯白的桔梗 往我身上一放 星辰,太阳和埋...
    娃娃的manly阅读 360评论 1 3
  • 第一段 1.预备势2.太极起势3.揽雀尾4.单鞭5.提手上势6.白鹤亮翅7.搂膝拗步8.手挥琵琶9.进步搬拦捶10...
    起合太极孙康阅读 1,706评论 0 0