Xcoed 添加自定義docset文檔

須要安裝使用的工具 appledoc

安裝方法(一):終端輸入命令git

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

 2.cd ./appledoc
 
 3.sudo sh install-appledoc.sh

安裝方法(二): 終端輸入命令 (條件:已安裝過Homebrew)github

brew install appledoc

使用已安裝的appledoc 生成 docset文件

終端 cd 到xcode所在的目錄 輸入命令:(YYY爲想要生成文檔的項目名xcode

appledoc --project-name YYY --project-company General .

更新 保存註釋文檔

確認註釋添加完後前往~/Library/Developer/Shared/Documentation/DocSets/ 目錄將已生成好的 General.YYY.docset 上傳到appleDoc模塊根目錄下app

查看註釋文檔

查看方法(一):打開finder 點擊前往文件夾,輸入:~/Library/Developer/Shared/Documentation/DocSets/ 點擊其中一個文件顯示包文件 最後的Html 文件 能夠打開在網頁上瀏覽。
圖片描述
圖片描述工具

查看方法(二):或者用Dash 工具閱讀也是很方便的。spa

查看方法(三):藉助xcode的幫助文檔查看。3d

相關文章
相關標籤/搜索