pixyzehn blog

iPhone App, Mac App, Programming, Web service, Tool, Evernote, etc

javadocライクなコメントが書けるXcodeプラグインVVDocumenter

f:id:inagex:20140519102816p:plain


使ってみてよかったので、共有します。


以前からこのプラグインは知ってはいたのですが、使ってはいませんでした。


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


まえに書いたあるいは理解したコードとかを時間が経ってから見ると把握するのに時間がかかったり、ちょっと効率的ではないことが多々ありました。


そこでdescriptionがあったりするとすんなりわかるし、最近ちょっとした説明とかを書いていました。


普通にコメントを書いてもいいですが、どうせなら見るときに綺麗なほうがいいと思い、このjavadocライクなコメントが書けるVVDocumenterを使ってみました。


インストールは、Xcodeプラグインを管理するAlcatrazを使うといいです。


後のコードに引数があるとそれを自動で認識して入力しやすくしてくれます。


例えば

- (void) tableView:(UITableView *)tableView didSelectRowAtIndexPath:(NSIndexPath *)indexPath;


というメソッドは引数が(UITableView *)tableViewと(NSIndexPath *)indexPathのふたつがありますが、


f:id:inagex:20140519105441p:plain


こんな感じで引数の説明が容易にできます。


引数がないと


f:id:inagex:20140519105629p:plain


単純な説明のみを記述できます。


VVDocumenterを使って、自分が後からみても他人がみてもわかりやすいコードを書きたいと思いました。


ぜひ使ってみてください。


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