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生成文檔

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,837評論 18 139
  • 一.首先需要安裝appleDoc,有兩種方法操作: 1.直接從github上下載下來: gitclonegit:/...
    海闊天空_棟閱讀 1,141評論 0 1
  • 前言 本篇文章主要講解如何使用不同的工具來生成HTML注釋文檔 , 對于注釋的使用和說明你可以在注釋使用這篇文章得...
    與偉大LEE同行閱讀 2,488評論 2 5
  • 轉至元數據結尾創建: 董瀟偉,最新修改于: 十二月 23, 2016 轉至元數據起始第一章:isa和Class一....
    40c0490e5268閱讀 1,757評論 0 9
  • (鬼知道我怎么起了個這么中二的題目) 連續兩個晚上做了關于三翼的夢。 第一晚夢到熟悉到不需要客氣的老臘肉。 第二晚...
    音然閱讀 202評論 0 0