親測可用iOS開發appledoc工具安裝使用體驗

前言：

demo地址

網上不少關於appledoc的使用，要麼比較久的，要麼講解的不是很清晰，按照他們的步驟執行沒成功，so，根據本身安裝使用成功和遇到的問題，記錄一下：

背景：

項目源碼交接給另一個公司的開發人員，須要爲他們提供app大體的使用文檔，CTO問：大家是否有相似java的javadoc源碼文檔工具，百度了一下：答案是有的，iOS也有appledoc，並且appledoc最後生成一個indxe.html文件，打開index.html文件會顯示iOS官方API同樣風格的文檔，是否是還蠻棒棒的！

體驗：

安裝：打開終端一步步執行下面的命令

$ git clone git://github.com/tomaz/appledoc.git
$ cd ./appledoc
$ sudo sh install-appledoc.sh
複製代碼

驗證：安裝是否成功

# 查看版本，若是顯示版本，則證實安裝成功
$ appledoc --version
# 查看appledoc的命令
$ appledoc --help
複製代碼

appledoc --version

使用：重點來拉，認真執行下面這三個步驟就行，看清截圖

• 一、建立一個Xcode項目，項目名：demo，並建立一個文件測試生成文檔；
• 二、cd 到項目文件夾；
• 三、執行終端命令
  具體步驟：

• 一、建立一個Xcode項目，項目名：demo，並建立一個文件測試生成文檔：

  
  
  

  SoundBusTool類
• 二、cd 到項目文件夾：

cd 到項目的文件夾
複製代碼

項目目錄

• 三、執行終端命令

$ appledoc --no-create-docset --output="./doc" --project-name="工程名" --company-id="bundle id" --project-company="公司名" .
複製代碼

執行終端命令

打開index.html文件

查看文檔

遇到的兩個問題：

• 問題1:執行終端命令doc文件夾下沒有生成index.html文件，緣由是：沒有給Xcode建立的demo項目寫註釋，解決，若是我在appdelegate.h中，隨便給方法添加一個註釋，而後在執行終端命令就能成功生成index.html文件；

  
  
  

  問題1錯誤提示docsetutil：
  
  
  

  解決1

• 問題2:在原來的項目中，執行命令，沒有生成doc文件夾；

  
  
  

  問題2錯誤提示：Invalid parameter not satisfying: [arguments count] >= 1
  
  
  

  解決2

靠譜的參考：

參考連接1
參考連接2

本人的一點開發小記，若是對你有幫助歡迎小❤️❤️，另不吝賜教。

小編這呢，給你們推薦一個優秀的iOS交流平臺，平臺裏的夥伴們都是很是優秀的iOS開發人員，咱們專一於技術的分享與技巧的交流，你們能夠在平臺上討論技術，交流學習。歡迎你們的加入（想要加入的可加小編微信15673450590）。

做者：pengshuangta 連接：https://www.jianshu.com/p/44f51e483508#comments