問題タブ [headerdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
objective-c - Objective-C - コード ファイルではなくドキュメント ヘッダー?
コードのドキュメント化を適切に開始したいのですが、HeaderDoc が読み取れるように配置するのに最適な場所がわかりません。HeaderDoc ドキュメントで次のフレーズを読みましたが、(Apple の観点から) 意図した場所はヘッダー ファイルにあると思いますか?
(上記のように) 単一の入力ファイルを指定する代わりに、必要に応じて入力ディレクトリを指定できます。HeaderDoc は、入力ディレクトリ (およびそのすべてのサブディレクトリ) 内のすべての .h ファイルを処理し、HeaderDoc コメントを含む各ヘッダーの HTML ファイルの出力ディレクトリを生成します。
これは正しいですか？ドキュメントを置く場所は異なりますか?
xcode4 - 自分の HeaderDoc を Xcode で見る
私は多くの C# を作成しており、Visual Studio では、関数とそのパラメーターを説明するオートコンプリートが表示されたときに、自分のドキュメントを見ることができます。私の HeaderDoc 記述を使用して、これと同じ機能を Xcode で利用できますか?
回答の関連性に役立つ場合は、Xcode 4 を使用しています。
code-snippets - Headerdocでコードスニペットをマークする方法は？
私は通常、のようなコードコメントで多くの短いコードを書く必要がありますthis。これはAppleのHeaderdocで使用できますか？このタイプのコード表記は一般的に頻繁に使用されるため、HTMLタグをマークする代わりにこれを行うための便利な方法があると思います。
objective-c - コメントで @discussion を使用する利点は何ですか?
いくつかのサンプル コードで @discussion を見ています。私の質問は、このキーワードを使用する利点は何ですか?
より良いドキュメントが生成されると思います。Google や Stackoverflow で検索してみましたが、このキーワードの使い方どころかコードサンプルがたくさん出てきました。ありがとう。
c++ - .hファイルの代わりに.hppファイルでHeaderDocを使用する
インターフェイスを文書化したい。インターフェイスはC++で記述されており、.hppファイルに含まれています。ただし、headerdoc2html.hppファイルについては知らないようです。.hファイルが必要です。
どうすればHeaderDocに入力をC++コードとして解釈させることができますか？
doxygen - Objective-C ドキュメント ジェネレーター: HeaderDoc vs. Doxygen vs. AppleDoc
職場にドキュメント生成ソリューションを実装する必要があり、タイトルに記載されている 3 つに絞り込みました。これらのソリューションを正式に比較する方法で、私はほとんど情報を見つけることができませんでした。上記の 1 つまたは複数の経験をお持ちの方が参考になることを願っています。
これが、最初のパスから収集できたものです。
HeaderDoc 長所: Apple の既存のドキュメントと一貫性があり、Apple Docsets の作成と互換性が
ある）。
Doxygenの長所: 幅広い使用ベースの活発なサポート コミュニティ b/c、非常にカスタマイズ可能、ほとんどの出力タイプ (latex など)
AppleDoc 長所: Apple の既存のドキュメントと一貫性があるように見える、Apple Docset の作成との互換性がある、
AppleDoc 短所: typedef、enum、関数のドキュメントに問題があり、活発に開発されている
これは正確に聞こえますか？望ましいソリューションには次のものがあります。
- apples Objective-C クラス リファレンスとの一貫したルック アンド フィール
- オプションを押しながらクリックして Xcode 内からドキュメント リファレンスを取得し、ドキュメントにリンクする機能 (Apple のクラスと同様)
- カテゴリ、拡張機能などのスマートな処理 (Apple のクラスのカスタム カテゴリも)
- 独自の参照ページを作成する機能 (このページのように: Loading... には、画像を含めることができ、生成されたクラス参照からシームレスにリンクできます。たとえば、Apple の UIViewController クラス参照がリンクされたページにリンクする方法のように.
- ビルド スクリプトに統合できる、実行しやすいコマンド ライン コマンド
- 非常に大きなコードベースの適切な処理
上記のすべての情報に基づいて、上記のソリューションのいずれかが他のソリューションよりも明らかに優れていますか? 追加する提案や情報は非常に高く評価されます。
objective-c - Objective Cにヘッダードキュメントコメントを自動的に挿入しますか?
XCode 5 がヘッダー ファイルからヘッダー コメントを直接読み取ることをサポートするようになったため、一貫した方法で機能を文書化することがますます重要になっています。
したがって、Objective C ヘッダー ファイルにヘッダー ドキュメント コメントを自動的に挿入できるツールを見つけようとしましたが、見つからないようです。
基本的に、私は次のようなものを書くことができるテイクが欲しいです:
ios - HeaderDoc に複数行のコメントを追加する方法
これは私のコードです
そしてWOC_OnOffImageButton、ポップアップ内でalt-clickすると、すべてが1行Descriptionに表示されます。In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images
... click. Automatically...読みやすいので、間に改行を入れたいと思います。
質問
可能ですか、可能であればどのようにすればよいですか?