iOS使用appledoc来创建开发文档(装逼使用)

1:安装appledoc

     使用终端下载:

      命令行:

        git clone git://github.com/tomaz/appledoc.git

         cd ./appledoc

        sudo sh install-appledoc.sh

  查看是否安装成功:

       命令行:

         appledoc --version

如果显示如下则安装成功:

2:使用appledoc

使用终端到项目的目录:

  cd  项目路径

使用命令行创建docset-installed.txt,默认安装到当前项目中

appledoc --project-name 你的项目名称 --project-company 你的公司名称 ./

成功之后会显示如下:

接下来在项目里创建新建Target:

下面俩种都可以:


然后替换脚本:

#appledoc Xcode script

# Start constants

company="asd";//记得更改公司名

companyID="com.adaada";//记得更改公司id

companyURL="http://abc.com";//记得更改公司网址

target="iphoneos";

#target="macosx";

outputPath="~/help";//输出地址

# End constants

/usr/local/bin/appledoc \

--project-name "${PROJECT_NAME}" \

--project-company "${company}" \

--company-id "${companyID}" \

--docset-atom-filename "${company}.atom" \

--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \

--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \

--docset-fallback-url "${companyURL}/${company}" \

--output "${outputPath}" \

--publish-docset \

--docset-platform-family "${target}" \

--logformat xcode \

--keep-intermediate-files \

--no-repeat-first-par \

--no-warn-invalid-crossref \

--exit-threshold 2 \

"${PROJECT_DIR}"

最后更改好之后我们run 一下Target就可以了;至于开发文档在哪看下面的图,

根据这个路径我们可以找到:

然后查看包内容可以看到:

打开index.html之后就可以看到开发文档了


最后我要说的使用开发文档的一些注释方法(摘自Raybon_lee的iOS使用appledoc 生成技术API文档详解):

/*!  this a test . */

 /**  this a comment. */

/// this is a long comment. */

@brief : 使用它来写一段你正在文档化的method, PRoperty, class, file, struct, 或enum的短描述信息。

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

@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生成文档

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,833评论 19 139
  • 一.首先需要安装appleDoc,有两种方法操作: 1.直接从github上下载下来: gitclonegit:/...
    海阔天空_栋阅读 4,811评论 0 1
  • 前言 本篇文章主要讲解如何使用不同的工具来生成HTML注释文档 , 对于注释的使用和说明你可以在注释使用这篇文章得...
    与伟大LEE同行阅读 7,300评论 2 5
  • 转至元数据结尾创建: 董潇伟,最新修改于: 十二月 23, 2016 转至元数据起始第一章:isa和Class一....
    40c0490e5268阅读 5,873评论 0 9
  • (鬼知道我怎么起了个这么中二的题目) 连续两个晚上做了关于三翼的梦。 第一晚梦到熟悉到不需要客气的老腊肉。 第二晚...
    音然阅读 1,535评论 0 0

友情链接更多精彩内容