產生iOS-Xcode技術文檔

標籤：tle   cti   嘻嘻   int   code   div   developer   使用   記錄   

從源碼中抽取注釋產生文檔的專用工具：

[doxygen](http://www.stack.nl/~dimitri/doxygen/index.html)：適於產生html文檔與pdf文檔。 支援的語言多，可以配置的地方也比較多。預設產生的風格與蘋果的風格不一致。[headdoc](http://developer.apple.com/opensource/tools/headerdoc.html) ：是 Xcode 內建的文檔產生工具。在安裝完 Xcode 後，就可以用命令列來產生對應的文檔。不過它只產生以/*! */的格式的注釋。不相容 /** */格式的注釋[appledoc](http://gentlebytes.com/appledoc/): [Github地址](https://github.com/tomaz/appledoc) ，適於產生html文檔和xcode協助文檔（docset）。可以相容 /** */格式，也可以相容 /*! */格式的注釋。

我直接選取了 appledoc,下面是安裝步驟和使用步驟:

安裝兩種方式：

1 如果你裝了homebrew，開啟終端，輸入以下命令：

brew install appledoc

第一次用的這種方式，安裝雖然成功了但是去找不到產生的html檔案，後來找到了檔案開啟之后里面的內容卻不對，所以如果有朋友看到後可以告訴我怎麼回事，先謝謝了~
2 開啟終端，輸入以下命令:

git clone git://github.com/tomaz/appledoc.gitcd appledocsudo sh install-appledoc.sh

我這裡是選用的第二種方式,不知道是網速慢還是什麼,等了太久就結束第一種方式,開始了第二種方式了.

3.終端命令執行完之後,進行以下操作,如所示,則表示成功了.

使用

首先建立一個項目appledoc,為了便於示範，寫幾個注釋：

////  ViewController.m//  AppleDoc////  Created by 思 彭 on 2017/4/5.//  Copyright ? 2017年 思 彭. All rights reserved.//#import "ViewController.h"// 主控制器@interface ViewController ()@property (nonatomic, strong) NSString *name; /**<名字 */@property (nonatomic, strong) NSString *sex; /**<性別 */@property (nonatomic, assign) NSInteger age; /**<年齡 */@property (nonatomic, strong) NSString *address; /**<住址 */@end@implementation ViewController- (void)viewDidLoad {    [super viewDidLoad];}/** 網路要求方法 @param params 需要的參數 */- (void)netWork: (NSDictionary *)params {    }/** 返回字串方法 @param string 傳遞字串 @return 返回的字串 */- (NSString *)string: (NSString *)string {        return string;}@end

終端輸入命令:

使用命令建立//格式：appledoc --project-name 你的項目名稱 --project-company 你的公司名稱 ./       appledoc --project-name appledoc --project-company combanc ./

如所示:(格式中文的地方試了一下自己指定的喲),則表示成功建立注釋文檔了.

會在專案檔下產生以下檔案:

開啟該檔案,這裡的路徑就是產生文檔的路徑了，一般是html格式，順著路徑找下去

以下就是我產生的三個文檔包:

 

右鍵顯示包內容,這個html檔案就是你需要的了開啟如下:

最後開啟html檔案,效果顯示如下:

大工告成啦..嘻嘻,原諒我昨天為了趕公交,今早補的部落格記錄啦......

 

產生iOS-Xcode技術文檔