WonderPlanet DEVELOPER BLOG

ワンダープラネットの開発者ブログです。モバイルゲーム開発情報を発信。

Javadocスタイルのコメントを追加する

今回エンジニアブログを担当する戸田です。

今回は、Javadocスタイルのコメント追加ができる、Xcodeプラグインについて紹介します。

インストール方法

1. GitHubの「VVDocumenter-Xcode」からソースをダウンロードします。

URL:https://github.com/onevcat/VVDocumenter-Xcode

2. ダウンロードしたソース内のプロジェクトファイルを、Xcodeで開きます。

3.メニューの「Product」➝「Build」で、ビルドを実行します。
VVDocumenter002

4.ビルドが終了後、自動的にインストールがされます。

5.Xcodeを再起動します。

利用方法

ソースコードの任意の箇所で。「///」を入力することでJavadocスタイルのコメントが追加されます。

VVDocumenter003

VVDocumenter004

アンインストール方法

1.起動しているXcodeを終了します。
2.以下のフォルダ内の「VVDocumenter-Xcode.xcplugin」ファイルを削除します。
/Users/[ユーザーアカウント]/Library/Application Support/Developer/Shared/Xcode/Plug-ins

紹介したプラグインにより、クラスや関数のコメント追加の作業効率や可読性が良くなると思います。ぜひ使用して見て下さい。