VVDocumenter-Xcode

 

VVDocumenter-Xcode 

 

點擊打開連接

Github下載地址: https://github.com/onevcat/VVDocumenter-Xcode

 

（1）下載插件

（2）用Xcode打開VVDocumenter，選擇VVDocumenter-Xcode.xcodeproj工程,進行編譯（Cmd ＋ B）

（3）完成後退出Xcode，並重啓。

（4）當Xcode打開後，會彈出一個對話框，這時默認的是Skip Bundle，要選擇的是另外一個Load Bundle。

 (5)再使用Xcode時就可使用/// 快捷註釋

效果:

[objc] view plaincopy

 

1. /** 
2.  *  <#Description#> 
3.  */  

 

 

設置VVDocumenter-Xcode註釋樣式

打開一個XCode工程 找到window 下的VVDocumenter  選項

VVDocumenter 的設置很詳細:  (設置是當即生效 能夠選擇後就試看效果 選擇本身喜歡樣式)

 

選擇以後的註釋樣式:

/*!

*  @author Vic_Li, 15-10-30 13:10:14

*

*  @brief  <#Description#>

*

*  @return <#return value description#>

*/

 

 

/*!

*  @author Vic_Li, 15-10-30 13:10:38

*

*  <#Description#>

*  @return <#return value description#>

*/

 

 

/*!

@author Vic_Li, 15-10-30 13:10:30

 

@brief  <#Description#>

 

@return <#return value description#>

 

@since <#vicli#>

*/

/**

*  @author Vic_Li, 15-10-30 13:10:49

*

*  @brief  <#Description#>

*

*  @return <#return value description#>

*

*  @since <#vicli#>

*/

 

/**

*  @author Vic_Li, 15-10-30 13:10:55

*

*  <#Description#>

*

*  @return <#return value description#>

*/

 

/**

*  @author Vic_Li, 15-10-30 13:10:42

*

*  <#Description#>

*

*  @return <#return value description#>

*

*  @since <#version number#>

*/

 

 

/**

 *  <#Description#>

 */

 

 

 

還有關於XCode版本升級後的使用問題-- 解決方法

 

VVDocumenter-Xcode是Xcode上一款快速添加標準註釋，並能夠自動生成文檔的插件。有了VVDocumenter-Xcode，規範化的註釋，只須要輸入三個斜線「///」就能夠搞定，很是方面實用，目前已經支持Swift。

 

Objective-C效果圖：

 

 

Swift效果圖：

 

從Xcode 5開始，蘋果要求加入UUID證書從而保證插件的穩定性。所以Xcode版本更新以後須要在VVDocumenter-Xcode的Info.plist文件中添加Xcode的UUID。

 

步驟以下：

1、查看Xcode的UUID

方式1

在終端執行 defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID

拷貝選中的字符串。

 

方式2

在/Applications目錄中找到Xcode.app，右鍵」顯示包內容」，進入Contents文件夾，雙擊Info.plist打開，找到DVTPlugInCompatibilityUUID，拷貝後面的字符串。

 

2、添加Xcode的UUID到VVDocumenter-Xcode的Info.plist文件

方式1--插件已經安裝完成

一、打開xcode插件所在的目錄：~/Library/Application Support/Developer/Shared/Xcode/Plug-ins；

二、選擇已經安裝的插件例如VVDocumenter-Xcode，右鍵」顯示包內容」；

三、找到info.plist 文件，找到DVTPlugInCompatibilityUUIDs的項目，添加一個Item，Value的值爲以前Xcode的UUID，保存。

 

方式2--插件還未安裝/從新安裝

一、從GitHub克隆倉庫到本地，在Xcode中打開項目，選擇項目名稱，在TAGETS下選中VVDocumenter-Xcode；

二、選擇Info，找到DVTPlugInCompatibilityUUIDs的項目，添加一個Item，Value的值爲以前Xcode的UUID；

三、Build項目，VVDocumenter-Xcode會自動安裝。

 

3、重啓Xcode

Xcode 6以後，重啓Xcode時會提示「Load bundle」、 「Skip Bundle」，這裏必須選擇「Load bundle」，否則插件沒法使用。