問題タブ [headerdoc]

Web フレームワークでパーシャルとしてレンダリングされるドキュメント用の html ファイルを作成するために、headerdoc を使用しています。ヘッダー ドキュメントが生成する html ファイルから head、html、および body タグを防ぐ方法があるかどうかを知りたいです。これらのドキュメントは Web テンプレート内でレンダリングされるためです。

Xcodeの次の2つのコメント構文に違いがあるかどうかを誰かが説明できるかどうか疑問に思っていました。

どちらも Xcode でコメントをドキュメントとして表示できるようですが、両者に違いがあるかどうかはわかりません。

iOS アプリ用の再利用可能な API コンポーネントに取り組んでいます。headerdoc私はAPIを完成させ、将来のユーザーのためにそれを使用して文書化しました。

ここで、これらのヘッダー ファイル用の HTML ページを作成したいと考えています。そこで、プロジェクトディレクトリからターミナルで次のコマンドを実行しました

しかし、ドキュメントは作成されていません。代わりに、次のようなエラーが表示されます。

さまざまな方法と方法を試しましたが、最終的に問題を絞り込みました。

私のプロジェクトの初めに、私は次のようなものを持っています:

したがって、問題はこの特定のコメントにありました。実際、このコメントは XCode によって自動生成され、実際に名前とコメントの形式をheaderdoc. 日付または日付形式はありません。それらのコメントを削除しても、何も機能しません。同じエラーが発生します。誰でもこれを解決するのを手伝ってもらえますか?

自分のドキュメントに UIKit メソッドへのリンクを追加しようとしています。このドキュメントによると、リンク@see付きのタグを追加する必要があります。//apple_ref/

これが私のドキュメントです：

結果は次のとおりです。

どうすればいいですか？

編集：同じ質問が@see同じファイルに当てはまります。

ブロックをパラメーターとして持つメソッドを作成しました。ブロックはいくつかの引数を取るので、Apple が同様の形式を持つメソッドで行うように、ドキュメントをインデントしたいと思います...

これがコードでどのように見えるかの簡単な例は次のとおりです。

しかし、明らかに、これはドキュメントでは次のようにしか表示されません。

引数付きのブロックを取る Apple のメソッドのように、インデントを取得dataして表示するにはどうすればよいですか?fields

AppleのHeaderDocに関するドキュメントでこれを行う方法を見つけることができませんでした

XCode で headerDoc タグを使用していますが、.m ファイルでプライベート メソッドを文書化できないようです。Apple のサイトから直接サンプル構文を使用します。

次のエラーが発生します。

@implementation ブロックの外側の headerDoc タグは、このエラーなしで機能します。

コードを文書化するために HeaderDoc を使用していますが、文書内の他のメソッドにリンクしたいと考えています。HTML を生成しようとはしていませんが (少なくとも今のところ)、Xcode の右側のパネルに表示させたいと思っています。-applicationDidEnterBackground:以下は、 Xcode で表示されるのドキュメントです。自分で書いた他のメソッドを参照する青いリンクを実現したい:

ドキュメントには を使用するように書かれています@linkが、うまくいかないようです:

これが私が試したことです：

結果は次のとおりです。

ご覧のとおり、正しくレンダリングされていません。私は壊れているここを読みました@linkが、コメントは2013年にさかのぼります.修正はありますか? 私はそれを間違っていますか？

編集：私はサンタの提案を試みました、これは結果です：

次のようにレンダリングします。

Xcode プロジェクトの文書化に headerDocs を使用しています。そして、プロジェクトの文書化に成功しました。しかし、 内の headerdoc コメントのscriptを知りたいです。headerdoc を実行し、それを. 誰かがheaderdocを自動的に実行するスクリプトを手伝ってくれます. 前もって感謝しますautomatically generatehtml outputXcodeTerminal