Xcode で API コメント

Xcode で API コメントを書く際、補完機能が全く無いのが不便で、調べてみたらプラグインの紹介記事が見つかったのでメモ。

「VVDocumenter-Xcode」というプラグインを導入すると自動補完機能が得られるらしい。
が、その前に「Alcatraz」というパッケージマネージャを導入する。

ターミナルで以下を実行すると、インストールされる。

$ curl -fsSL https://raw.githubusercontent.com/supermarin/Alcatraz/deploy/Scripts/install.sh | sh
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed
100   590    0   590    0     0    322      0 --:--:--  0:00:01 --:--:--   322
 15  110k   15 16975    0     0   3984      0  0:00:28  0:00:04  0:00:24  8981x Alcatraz.xcplugin/
x Alcatraz.xcplugin/Contents/
x Alcatraz.xcplugin/Contents/Info.plist
x Alcatraz.xcplugin/Contents/MacOS/
x Alcatraz.xcplugin/Contents/Resources/
x Alcatraz.xcplugin/Contents/Resources/ATZPackageListTableCellView.nib
x Alcatraz.xcplugin/Contents/Resources/ATZPluginWindowController.nib
x Alcatraz.xcplugin/Contents/Resources/bitbucket_grayscale.tiff
x Alcatraz.xcplugin/Contents/Resources/en.lproj/
 45  110k   45 50767    0     0   9669      0  0:00:11  0:00:05  0:00:06 17633
x Alcatraz.xcplugin/Contents/Resources/git_grayscale.tiff
x Alcatraz.xcplugin/Contents/Resources/github_grayscale.tiff
x Alcatraz.xcplugin/Contents/Resources/link_icon.tiff
x Alcatraz.xcplugin/Contents/Resources/en.lproj/InfoPlist.strings
x Alcatraz.xcplugin/Contents/Resources/en.lproj/Localizable.strings
100  110k  100  110k    0     0  15659      0  0:00:07  0:00:07 --:--:-- 23353

Alcatraz successfully installed!!1! Please restart your Xcode (7.3).

Xcode を再起動すればパッケージマネージャの導入は完了。
再起動時に警告がでるので「Load Bundle」をクリック。


Xcode のメニューから「Window」->「Package Manager」をクリックすると、パッケージマネージャが開くので、「VVDocumenter-Xcode」を検索し、「INSTALL」をクリック。


インストール後、Xcode を再起動すると有効になる。
関数の前の行で「///」を入力すると API コメントのスケルトンが挿入されるので、適宜修正する。

うん、こりゃ便利。
だけど、デフォルト設定だとブロックコメント形式なのが気にいらない。

/**
 Description

 - parameter callBackCycle: <#callBackCycle description#>
 - parameter callBackFunc:  <#callBackFunc description#>

 - returns: <#return value description#>
*/

Xcode のメニューから「Window」->「VVDocumenter」をクリックすると、設定画面が開く。
一番下の「Prefix each comment line with three slashes」を選択するとラインコメント形式になる。


これでよし。

///  <#Description#>
///
///  - parameter callBackCycle: <#callBackCycle description#>
///  - parameter callBackFunc:  <#callBackFunc description#>
///
///  - returns: <#return value description#>