JavaDoc を使用してカスタム定義タグからメモのリストを作成することは可能ですか? コード全体にフラグを立てたいビジネス ルールがありますが、それは、私が知っている既存のタグのいずれにも当てはまりません。次のようなことをするタグがあったとします。
@note ロジック - このコンテナには 12 個のウィジェットしか持てません
これは一種の制約または要件の逆ドキュメントであり、元の仕様の一部であるとは限らないため、これらをドキュメント化したいと思います。ソースコードでそれを文書化したい理由の1つは、ソースコードが失われることはないように見えるのに対し、設計仕様は... (言うまでもなく、誰もそれらを読んでいないようです)
通常のJavadocコメント自体に入れてみませんか？クラス、メソッドなどの要約の説明として。これは完全に受け入れられ、JDK自体のほとんどが文書化されている方法です。
それだけでは不十分な場合は、メンバー/メソッド/クラスにタグを付けるカスタム属性を作成して、プログラムでクラスを簡単にスキャンし、すべてのメモを見つけることができます。
@CustomNote("You can only have twelve widgets in this container")
public class WidgetContainer {
...
XDoclet は、やりたいことに合わせてカスタマイズできるはずです。
Java 1.5 以降を使用している場合は、通常の注釈を使用してレポートにコンパイルできます。手順は次のとおりです。これは、XDoclet アプローチよりも明らかに単純です。