iOS生成代碼注釋文檔

Today(2015/10/12)在網上搜索iOS對應的文檔生成工具也還是Doxygen,HeaderDoc和appledoc,好像幾年前就一直是這樣了0.0。

1.Doxygen可適用于C、C++之類的,但不是我要的。

2.HeaderDoc是Xcode自帶可生成html文檔,且命名格式和官方相近。

3.appledoc生成的文檔可在Xcode中查看到,并可在編輯代碼時對應查看。

綜上,Doxygen就這樣,HeaderDoc和appledoc在接下來會給到對應安裝以及使用介紹,主要給我個人后續(xù)查看0.0


一、HeaderDoc的使用

1.Xcode自帶,不用安裝0.0

2.在終端使用以下命令進行導出和生成文檔:

headerdoc2html -o OutputDirectory InputDirectory

gatherheaderdoc OutputDirectory TOC.Html

3.然后在瀏覽器中打開TOC.Html(如未填寫則默認masterTOC.html)文件便是代碼的注釋文件。

注意:

OutputDirectory目錄是文檔導出的目錄,而InputDirectory目錄是工程文件存在的目錄。

代碼中注釋需要使用/*!注釋內容*/才會被識別。

參考:

HeaderDoc的官方介紹文檔

HeaderDoc Tags(HeaderDoc注釋)

使用Xcode HeaderDoc和Doxygen文檔化你的Objective-C和Swift代碼


二、appledoc的使用

1.安裝方法1:通過github工具

前提:有安裝Xcode和命令行工具,并先裝好github工具

在命令行中下載安裝appledoc:

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

cd appledoc

sudosh install-appledoc.sh

安裝方法2:使用brew ?不介紹

2.使用appledoc生成文檔

使用終端cd到待生成的工程目錄

appledoc -o ./doc --project-name 項目名 --project-company 公司名 .

以上項目名和公司名公司名替換成正常的名稱,/doc可改成對應的路徑

appledoc 會掃描當前路徑下的所有文件,然后生成好文檔放到 doc 目錄下。然后就可以到Xcode的文檔目錄下進行查看:

參考:

appledoc官方文檔

github下載地址

使用Objective-C的文檔生成工具:appledoc

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容