Xcode を使用して、次のように、オートコンプリート オプションの下にメソッドの Doxygen の説明を表示したいと考えていますalloc。
書き込み時に、Xcode はドキュメントからのコメントを含むオートコンプリートを表示します。たとえば、allocオプションから を選択すると、「受信クラスの新しいインスタンスを返す」と表示され、ドキュメントへのリンクも表示されます。
たとえば、ソースコードを Doxygen で文書化することができました。
/**
This does nothing
*/
-(void) doNothing
{
// This does nothing
}
Doxygen が生成する HTML ファイルで期待どおりの結果が得られますが、それらの結果を Xcode で提案として表示する方法がわかりません。
皆さんに朗報です！Xcode 5 には、DOxygen スタイルのコメントのサポートが組み込まれています。したがって、次のようにメソッドにコメントできます。
/*!
* Provides an NSManagedObjectContext singleton appropriate for use on the main
* thread. If the context doesn't already exist it is created and bound to the
* persistent store coordinator for the application, otherwise the existing
* singleton contextis returned.
* \param someParameter You can even add parameters
* \returns The a shared NSManagedObjectContext for the application.
*/
+ (NSManagedObjectContext *)sharedContext;
Xcode コード スニペット ライブラリを追加して、メソッドのドキュメントを簡単にする便利なコード スニペットを次に示します。
/**
<#description#>
@param <#parameter#>
@returns <#retval#>
@exception <#throws#>
*/
これで、「doxy」と入力してポンッ！doxygen テンプレートがあります。
Doxygen/Javadoc スタイルのコメントのコード スニペットよりも優れていることがわかったのは、VVDocumenter-Xcode プラグインを使用することです。インストール後、コメントを付けたいコードの上に「///」と入力するだけで、パラメーターが取得されて返され、コメント ブロックを完成させるためのプレースホルダーが追加されます。