問題タブ [code-documentation]

私はこのフォーラムを調べましたが、これをグーグルで検索しましたが、同じクラスに一緒に表示されるJavadocとアノテーションを処理するための最良の方法がわかりません。

Sun / Oracleのドキュメントからわかるように、Javadocを注釈の上にリストする必要があることを示唆しているようです（明示的なステートメントは実際には見つかりませんが）。

APIを非推奨にする方法と時期の例を参照してください。

これは、@Deprecatedや@Overrideのような単純なものに最適です。しかし、JPAやHibernateを使用する場合はどうでしょうか。クラスとメソッドには、かなり多くのアノテーションが付けられる必要があります（クラスまたはメソッドごとに2つ以上のアノテーションが付けられる場合もあります）。

Javadocはまだアノテーションの上にあると思いますか？

また、注釈をどのように使用するのが最適か疑問に思います。クラス、メンバー、メソッドの上にアノテーションが「スタック」する例を見てきました。そして、同じ行に注釈をリストしている他の人を見たことがあります（通常はここのメソッド）。

どちらがベストですか？どちらが読みやすいですか？

そして、Javadoc内で何かに注釈を付けたかどうかという事実を「文書化」しますか？

私はこれについての優れたドキュメントのセット、および/または最も読みやすく/保守しやすいものについてのあなた自身の経験のいずれかを探しています。

コード ドキュメントとライブ テンプレートをいじっていますが、よくわかりません。

ドキュメントの生成に関するDr.Bob の記事と、ライブ テンプレートに関する wiki 記事を読みましたが、クラスの説明に 1 つの問題があります。

クラスの説明により、マウスカーソルをクラス宣言に合わせたときの IDE の動作を理解できます。

たとえば、そのようなクラスとその説明があります。

そして、コードの後半で、次のような宣言があります。

クラスタイプの上にマウスカーソルを置くと、次のような説明があります。

ご覧のとおり、すべての html タグが IDE エンジンによってレンダリングされたわけではありません。追加のタグ、特にコード例のタグをレンダリングする方法を本当に知りたいです。出来ますか？

Delphi 2009 Professional を使用しています。

コード ドキュメント エディター アプリを探しています。doxygen のような単なる生成ツールではなく、ドキュメントを編集してコードを直接変更できるアプリケーションを意味します。

良い編集者を知っている人はいますか？

ありがとう！

こんにちは皆さん : 古いページ、もう存在しないコードを参照するページ、リンクされていないページ、または更新頻度の低いページなどのアーティファクトを処理するプラグインを使用して、trac wiki の品質を向上させる方法はありますか?レート ？ウィキの腐敗を防ぐために使用できるヒューリスティックがいくつかあると思います。

• 最近の編集数
• 最近の閲覧数
• ページがソース ファイルにリンクしているかどうか
• Wiki ページの最終更新が < または > リンク先のソース ファイルであるかどうか
• ウィキ内のディレクトリ全体が、過去 "n" 日間に使用/編集/無視されたかどうか

等等等

これらのメトリックだけでも、管理上の観点から各ページと各ディレクトリに役立ちます。

modelFactory()Netbeans で開発しているときに、ドキュメント ヘルパーのツールチップからアクセスできるように、ドキュメントを作成できるかどうか興味があります。私のモデルは modelFactory() を通過するので、できることは.....

複数の結果があるかどうかに応じて、モデルの配列または 1 つのオブジェクトのみが返されます。それは本当に私のコードをかなり凝縮しています。問題は、他の開発者がこれを使い始めたときです$item。今回は「アイテム」モデルですが、次回はユーザー、ブログ投稿、またはその他の必要なものになる可能性があることに注意してください。

NetBeans のこの機能を文書化することは可能ですか? そうすれば、$item = new Item();利用可能なものを認識できるようになります。

アップデート

私が探しているのは、ModelFactory の出力が $item モデルであることを IDE に伝える方法です。これにより、IDE はメソッドのドキュメントを探す場所を認識します。

ReSharper 6.0 と StyleCop for ReSharper を使用しています。

メンバーにはドキュメント ヘッダーが必要であるという StyleCop ルールを使用していますが、ReSharper のコード クリーンアップ機能でドキュメント ヘッダーを生成することは望ましくありません。最初に追加されるよりも更新される可能性が低いため、不適切なドキュメントヘッダーはまったくないよりも悪いです。

ReSharper => Options => Tools => StyleCop で 'Insert text into documentation and file headers' の設定をオフにしようとしましたが、Visual Studio を再起動すると血まみれにリセットされます。

コード クリーンアップによるドキュメント ヘッダーの作成を停止する方法はありますか?

I'm writing my own documentation for a small ActionScript 3 library that I've written.

I'm trying to keep as close to the layout and content of the Adobe Livedocs as I can, while cleaning it up a little bit.

I think I've covered everything that people will want to know when reading my documentation, but I don't want to miss out on anything crucial before I start adding all of the classes I've created etc.

Is there anything you wish some documentation had? Are there things in most docs that you consider unessential?

Here's what I've got so far: https://projectavian.com/docs/zephyr/#/entity

Some things I've tried to cover are:

1. Easy direct links to documentation sections. ie /#/class.propertyOrMethod as above.
2. Neat tables at the top of the page listing briefly each property, method, constant or whatever other relevant staples are present in the class.
3. Clearly separated blocks of information relating to each property or method which can be navigated to directly by the URL in step 1. Clicking the relevant text in the tables at the top of the page will also link down to here.
4. Tidy layout for method arguments with concise explanations about each.

Visual Studioで、デフォルトのXMLサマリーコメントスニペットを3行から1行に変更するにはどうすればよいですか？

現在、次のように入力すると、このスニペットが提供されます///。

この短いスニペットが欲しいです：

私の要約はしばしば簡潔であり、余分な2行は不要です。

これまたはこれを修正するためのカスタマイズ可能なコード/カスタムアドオンの構成設定はありますか？

ソースコードの文書化のために Headerdoc と Doxygen を見てきましたが、どちらも最初に開発者がほとんどの作業を行う必要があるようです。Visual Studio では、型を入力\\\すると、メソッドが期待するパラメーターを含むドキュメントのスケルトンが生成されます。名前とパラメーターに基づいてメソッドが何をするかを推測するGhostdocもあります。Xcodeに似たものはありますか?