JavaDocでカスタムタグを使用してビジネスロジックを文書化しますか？

Question

JavaDocを使用してカスタム定義タグからメモのリストを作成することはできますか？私はコード全体にフラグを立てたいビジネスルールを持っており、私が知っている既存のタグのどれにも当てはまらない。あなたが唯一このコンテナ

それは一種の制約や要件のドキュメントを逆年代に12個のウィジェットを持つことができる、と私はしたいのですが -

@noteロジック：に似た何かをしたタグがあった場合、私は考えますそれらは必ずしも元の仕様の一部ではないため、これらを文書化してください。デザイン・仕様は、よく...（もちろんのこと、誰もがそれらを読んでいるようだ）しながら、私は、ソースコードで、それを文書化したい理由の一つは、ソースコードは決して迷子に思わないことです

Answer 1

理由だけではなく、通常のJavadocにコメントを入れてください。クラス、メソッドなどの概要の説明として。これは完全に受け入れられ、JDK自体のほとんどがどのように文書化されているかです。

それがあなたのために十分でない場合は、おそらくあなたは、あなたが簡単にプログラム的なクラスをスキャンし、あなたのノートのすべてを見つけることができる、とのメンバー/メソッド/クラスをタグ付けするためにカスタム属性を作成することができます。

@CustomNote("You can only have twelve widgets in this container") 
public class WidgetContainer { 
    ... 

Answer 2

XDocletは、自分のやりたいことにカスタマイズできる必要があります。

Java 1.5以降を使用している場合は、通常のアノテーションを使用してレポートにコンパイルできます。 Hereは説明書です。これは、XDocletのアプローチよりもはるかに単純です。