【iOS工具】註釋外掛 VVDocumenter-Xcode 的安裝使用及誤點選“Skip Bundle”的解決辦法!...

weixin_34185364發表於2017-12-13

一、前言

        VVDocumenter-Xcode 註釋外掛是由 @onevcat 大神開發的一個Xcode註釋外掛,其作用是在Xcode中輸入 "///" 後自動生成規範的文件註釋,超級強大實用!!!

       VVDocumenter-Xcode 外掛下載地址:github.com/onevcat/VVD…


截圖 01


二、VVDocumenter-Xcode 安裝

    1、先去 github 下載該外掛,並解壓;

    2、點選解壓資料夾中的 VVDocumenter-Xcode.xcodeproj 檔案,用 Xcode 進行開啟;


截圖 02

    3、編譯執行完成之後,完全退出 Xcode( command+q );

   4、再次開啟 Xcode 會彈出一個提示框,兩個選項,“Load Bundle” 和 “Skip Bundle”,一定要選擇 “左側” 的 “Load Bundle” 進行載入安裝,之後就可以正常使用;一定不要手殘習慣點選右側的 “Skip Bundle” 跳過載入安裝,外掛會安裝無效,不能使用,需要進行一些操作才能解決。


截圖 03

   5、安裝成功後,在 Xcode --> Window 視窗中可以找到外掛 VVDocumenter 即說明已經安裝成功了!


截圖 04


三、VVDocumenter-Xcode 使用

   1、在 Xcode 中的方法名前面或者是在空白處輸入  “///” 則會自動產生程式碼註釋規範,如下圖:


截圖 05


四、安裝過程中點選 “Skip Bundle” 後外掛失效的解決辦法

       有時可能因為使用者習慣的原因,習慣去預設點選彈框右側的選項,而造成的外掛失效,並且重新安裝時卻不會再次彈出該彈框而困擾,小編之前就因為手殘點選過,還是需要花一些時間去解決的。解決步驟:

  1、Xcode7之後需要先獲取 Xcode 應用的 UUID 才可以正常使用,可以通過在終端中輸入下面的命令即可獲取。記住是 Xcode 的 UUID,不是 MAC 電腦的 UUID;且當電腦中裝有多個版本的 Xcode 時,記得在終端中輸入的命令有所改變;

【 Xcode.app    應用的 UUID 】defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID

【 Xcode 2.app 應用的 UUID 】defaults read /Applications/Xcode\ 2.app/Contents/Info DVTPlugInCompatibilityUUID

【 MAC             電腦的 UUID 】ioreg -d2 -c IOPlatformExpertDevice



截圖 06


2、需要將之前編譯安裝的檔案進行清除,需要在兩個地方進行清除:

第一個:Finder -->前往 --> 前往資料夾 --> 輸入:~/Library/Application Support/Developer/Shared/Xcode/Plug-ins ;將該目錄下的 VVDocumenter-Xcode.xcplugin 檔案刪除掉;


截圖 07

第二個:找到註釋外掛資料夾,右擊 VVDocumenter-Xcode.xcodeproj 檔案,選擇 “顯示包內容”,將 “xcuserdata” 資料夾下的與自己電腦關了的資料資料夾刪除掉;


截圖 08



截圖 09


3、刪除這兩個檔案後,用Xcode開啟下載的外掛裡的檔案,找到 VVDocumenter-Xcode/Supporting Files/VVDocumenter-Xcode-Info.plist;在 DVTPlugInCompatibilityUUIDs 檔案中新增自己之前通過終端獲取的 Xcode 應用的 UUID;


截圖 10


4、當這些設定完成之後,再次編譯執行,之後完全退出 Xcode ( command+q );再次開啟 Xcode 時就會重新彈出一個選擇框,記住,這次一定要選擇 “Load Bundle” 選項,否則又要重複這些步驟了,切記,切記!!!


截圖 03


五、Xcode 8 使用的情況

   1、這前面寫的都是在 Xcode 8 之前的 Xcode 7 環境下的情況,在 Xcode 8 的環境下,由於蘋果 Xcode 自己整合了該方法,可以通過快捷鍵進行顯示:

快捷鍵:option + command + / 

  2、這樣的話就不需要使用 VVDocumenter 外掛了,不過還是要感謝 @onevcat 大神 為 iOS 開發做出的貢獻!!!

相關文章