web-dev-qa-db-ja.com

XcodeのオートコンプリートポップアップにDoxygenメソッドの説明を含めるにはどうすればよいですか？

Xcodeを使用して、allocのように、オートコンプリートオプションの下にメソッドのDoxygenの説明を表示したいと思います。

img

書き込み時に、Xcodeはドキュメントからのコメントとともにオートコンプリートを表示します。たとえば、画像で、オプションからallocを選択すると、「受信クラスの新しいインスタンスを返します」と表示され、ドキュメントへのリンクも表示されます。

たとえば、Doxygenを使用してソースコードを文書化することができました

/** 
 This does nothing
*/
 -(void) doNothing
{
    // This does nothing
}

doxygenが生成するHTMLファイルで期待される結果が得られますが、それらの結果をXcodeで提案として表示する方法がわかりません。

objective-cxcodeautocompletedoxygen
20
antonicelli

みなさん、朗報です！ 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;


インラインヘルプは次のようになります。

inline help



クイックヘルプは次のようになります。

quick help



サイドバーのヘルプは次のようになります。

sidebar help

Xcodeコードスニペットライブラリを追加してメソッドのドキュメントを簡単にすることができる便利なコードスニペットを次に示します。

/**
 <#description#>
 @param <#parameter#>
 @returns <#retval#>
 @exception <#throws#>
 */

doxygen code snippet

これで、「doxy」と入力するだけでプーフできます。あなたはあなたのdoxygenテンプレートを持っています。

52
memmons

Doxygen/Javadocスタイルのコメントのコードスニペットよりも優れていることがわかったのは、使用しています VVDocumenter-Xcodeプラグイン すばらしいです！インストール後、コメントしたいコードの上に「///」と入力するだけで、パラメータを取得して戻り、コメントブロックを完成させるためのプレースホルダーを追加します。

3
Josh

インストールとセットアップで少し戦ったが、Appledocsを使用して私が望んでいたことを達成することができた...

  1. XCodeを開き、xCode> Preferences> Downloadsに移動し、「コマンドラインツール」がない場合はダウンロードします。

  2. ターミナルを開いて入力します

    git clone git://github.com/tomaz/appledoc.git

  3. 完了したら、appledocフォルダーに移動し、次のように入力します。

    cd appledoc

    次のコマンドを使用して、appledocをusr/local/binフォルダーにインストールします。

    Sudo sh install-appledoc.sh

  4. XCodeプロジェクトを開き、左側のパッケージエクスプローラーに移動して、メインプロジェクトファイル（ターゲットの数と以下に詳述するSDKバージョンが含まれているファイル）をクリックします。

  5. [ビルド設定]タブで、以下の[+ターゲットの追加]ボタンを探して開きます

  6. 「Aggregate」テンプレートを選択します（プロジェクトに応じてiOSまたはmacosxを選択し、「Documentation」という名前を付けてください）

  7. [ドキュメント]を選択し、[ビルドフェーズ]タブに移動し、下の[ビルドフェーズの追加]をクリックして、[実行スクリプトの追加]を選択します。

  8. 以下のコードをコピーして、[スクリプトの実行]フィールドに貼り付けます。

    #appledoc Xcode script
# Start constants
company="ACME";
companyID="com.ACME";
companyURL="http://ACME.com";
#target="iphoneos";
target="macosx";
outputPath="~/help";
# End constants
/usr/local/bin/appledoc \
--project-name "${PROJECT_NAME}" \
--project-company "${company}" \
--company-id "${companyID}" \
--docset-atom-filename "${company}.atom" \
--docset-feed-url "${companyURL}/${company}/%DOCSETATOMFILENAME" \
--docset-package-url "${companyURL}/${company}/%DOCSETPACKAGEFILENAME" \
--docset-fallback-url "${companyURL}/${company}" \
--output "${outputPath}" \
--publish-docset \
--docset-platform-family "${target}" \
--logformat xcode \
--keep-intermediate-files \
--no-repeat-first-par \
--no-warn-invalid-crossref \
--exit-threshold 2 \
"${PROJECT_DIR}"

  9. 開始定数では、名前などを置き換えることができます。また、適切なターゲット（iOSまたはmacosx）を使用するようにしてください。

  10. 最後に、[製品]> [スキーム]> [スキームの編集]> [ビルド]タブに移動し、[ドキュメント]ターゲットを追加し、すべてのボックスがオンになっていることを確認します。このようにして、コードをビルドするたびにドキュメントが更新されます。

これで、コードの文書化を開始できます。ドキュメントはビルドするたびに更新されますが、ポップオーバーの提案はXcodeを再起動するまで更新されないことに注意してください。適切な文書化手法については、 この記事 をお読みください。

2
antonicelli