IOS技术分享| iOS快速生成开发文档（一）

前言

对于开发人员而言，文档的作用不言而喻。文档不仅可以提高软件开发效率，还能便于以后的软件开发、使用和维护。本文主要讲述 Objective-C 快速生成开发文档工具 appledoc。

简介

appledoc 是一个命令行工具，它可以帮助 Objective-C 开发者从特殊格式的源代码注释中生成类似 Apple 的源代码文档。它的设计目的是在输入时尽可能采 HTML 格式文档，以及完全索引和可浏览的 Xcode 文档集。

支持的注释

`/// 这是单行注释。`

`/** 这也是单行注释 */`

`/*! 同样是单行注释 */`

`/** 这也是单行注释，`

`*  第二行会接上第一行。`

`*/`

`/** 第一行是类的简介`

`在简介的下面,就是类的详细介绍了。`

`没有间隔换行会被消除，就像Html那样。`

`下面是常用的markdown语法`

`- - -`

`无序列表: (每行以 '*'、'-'、'+' 开头):`

`* this is the first line`

`* this is the second line`

`* this is the third line`

`有序列表: (每行以 1.2.3、a.b.c 开头):`

`a. this is the first line`