ITエンジニア/デザイナ向けにオープンソースを毎日紹介

VVDocumenter-XcodeはObjective-C製、Xcode用のオープンソース・ソフトウェア(MIT License)です。

チームでの開発補助などの目的にドキュメントを作成するのは大事なことです。しかしそれにとても大きな苦痛を感じる人も多いはずです。今回はそんなストレスを多少なりとも緩和できるVVDocumenter-Xcodeを紹介します。


目的のメソッドの一行上で「///」と入力すると、パラメータが一覧になってドキュメントのスケルトンが生成されます。


リターンがある場合はreturnも追加されます。

VVDocumenter-Xcodeを使えば/と*を何度も打つという苦痛から解放されます。予めメソッドの形が決まっていれば、引数も返り値も入りますので、スムーズに入力できることでしょう。ドキュメントが書きやすくなるはずです。


MOONGIFTはこう見る

ドキュメントが適切に整備されない原因は幾つかありますが、まず大きいのは作成、更新の工数が大きい事です。そこでVVDocumenter-Xcodeのようなソリューションを使えば入力補完が行われるのでスムーズになるはずです。

もう一つは必要とされないことです。絶対に必要であれば記述しなければならないと考えるのですが、そうでないとつい怠ってしまいます。全く必要でなければ作成する必要はありませんが、複数人での開発の場合は整備し、積極的に参照するようにすべきでしょう。

onevcat/VVDocumenter-Xcode

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2