XDOC Javaベースのアノテーションのインタフェース文書化ツール

Javaベースのインタフェースのドキュメンテーションコメント生成 - コード非侵襲的、ノーコメント、純粋なコードのコメント
サポートSpringWeb、SpringBoot、JFinal
ドキュメントの出力形式は、オフライン/オンラインHTMLなど値下げをサポート

なぜXDOC？

また文書は、外部のメンテナンス作業負荷を削減し、符号化処理との完全な、外部インタフェースを還元することにより調製しました
あなたは、コードを変更すると、外部インタフェースの過程を見てみると、コードのコメントで、直接見て書類を失っています
インターフェイスのドキュメントは一緒に、簡単にバージョン管理とマルチマルチバージョン環境だけでなく、ロールバックすることができます
あなたの作品への標準化されたインタフェースが存在しない場合は、ビジネスのプロジェクトがアップしないでください、その後、？標準化されなければならないなどの標準的なコメントはすべきではないですか？あなたは上で作るとヘルプ場合は、ドキュメントを生成し、なぜか？

どのように使用するには？

1. SpringBoot例：

<！ -  Mavenの依存含めます - >
<依存>
    <groupIdを> com.github.treeleafj </ groupIdを>
    <たartifactId>春・ブート・スタータXDOC </たartifactId>
    <バージョン> 1.1.0 </バージョン>
</依存関係>

@EnableXDoc // <--- XDOCオンラインHTMLドキュメントを有効にするために、このメモを追加
@SpringBootApplication
パブリッククラスTestApplication {

    パブリック静的無効メイン（文字列[] args）{
        SpringApplication.run（TestApplication.class、引数）。
    }
}

＃元の場所にApplication.properties設定項目に、プロジェクトがMavenの単一のモジュールであれば、プロジェクトに直接起動し、デフォルトを設定することはできません
XDOCを開始するには、デフォルトでは、本番環境を変更するには、真、偽の提案であるかどうかをxdoc.enable =真＃
xdoc.sourcePath = F：/ジャワ/プロジェクト/ XDOC /サンプル/サンプルspringboot / SRC /メイン/ Javaの＃ソースパス、パスのコンマによって分離された複数
xdoc.title =＃ユーザーインターフェイスのドキュメントセンターでは、文書のページタイトルを設定するために使用されます
xdoc.version = 1.0＃インターフェイスのドキュメントは、バージョン番号を特定します

もっとそれがすべて完了に設定する準備ができてより

次に、我々は唯一のコントローラー、いつものように、書き込みに必要、とのコメントを書き込みました。

/ **
 *ユーザモジュール
 *
 * @author treeleaf
 * @date 2017年3月3日10時11分
 * /
@コントローラ
@RequestMapping（ "API /ユーザー"）
パブリッククラスUserControllerで{

    / **
     *ログイン
     *
     * @Paramユーザ名、ユーザ名|必須
     * @Paramパスワードパスワード
     *現在について@Return基本的な情報は、ログオンしているユーザー
     * @Respコードリターンコード（ログインが成功したことを0000手段、失敗の他）|文字列|必須
     * @Resp MSGログイン|文字列
     成功したログインユーザ名の後に* @Respユーザ名のリターン|文字列
     * /
    @ResponseBody
    @PostMapping（ "ログイン"）
    公共の地図<文字列、文字列>ログイン（文字列名、文字列のパスワード）{
        地図<文字列、文字列>モデル=新しいHashMapの<>（）;
        model.put（ "コード"、 "0000"）。
        model.put（ "MSG"、 "ログイン成功"）;
        model.put（ "ユーザ名"、ユーザ名）。
        モデルを返します。
    }


    / **
     *ユーザー登録
     *
     * @Paramユーザー：ユーザー名、ユーザー名|必須
     * @Paramユーザー：パスワードパスワード
     @return登録ユーザーの後に生成された*基本情報
     * @respbody { "ID"： "123"、 "パスワード"： "123456"、 "ユーザ名"： "管理者"}
     * @seeユーザー
     * /
    @ResponseBody
    @RequestMapping（値= "登録"、メソッド= {RequestMethod.POST、RequestMethod.PUT}）
    ユーザレジスタ（ユーザのユーザ）{
        user.setId（UUID.randomUUID（）のtoString（））。
        ユーザーを返します。
    }
}

：書き込み後、直接アドレスを入力、プロジェクトを開始するにhttp：// localhost：8080 / XDOC / index.htmlをします

2.あなたはどのように行うには、オフラインドキュメントを生成したい場合は？

HTMLをサポートしています：

/ **
 * HTML形式で生成されたオフラインインターフェイスのドキュメント
 * /
@テスト
ます。public void buildHtml（）{例外がスローされます
    / ** NOTE !!!パスは、結果のファイルの実装は、インターフェースのリストは、説明は、スキャンされていない、彼らの着信パスが正しいか確認するために優先順位を与えてください開いていないプロジェクトのソースコードをスキャンすることができるようにするパスでなければなりません!!! * /
    FileOutputStreamアウト=新しいのFileOutputStream（新しいファイル（ユーザーディレクトリ、 "api.html"））;
    XDOCのXDOC =新しいXDOC（新しいファイル（ "F：/ javaの/プロジェクト/ XDOC /サンプル/サンプルspringboot / srcに/メイン/ジャワ"）、新SpringWebHttpFramework（））;
    xDoc.build（うち、新HtmlForamt（））;
}

また、値下げをサポートしています。

/ **
 *マークダウン形式が生成されたオフラインインターフェイスのドキュメント
 * /
@テスト
ます。public void buildMarkdown（）{
    何のインタフェースコンテンツが存在しない場合は/ ** NOTE !!!パスは自分の着信パスが正しいことを確認するために優先順位を与えてください、スキャンに説明しなかった、パスはプロジェクト、結果の値下げの実装のソースコードをスキャンすることができるようになる必要があります!!! * /
	
    =新しいByteArrayOutputStreamアウトByteArrayOutputStream（）;
    XDOCのXDOC =新しいXDOC（新しいファイル（ "F：/ javaの/プロジェクト/ XDOC /サンプル/サンプルspringboot / srcに/メイン/ジャワ"）、新SpringWebHttpFramework（））;
    
    xDoc.build（うち、新MarkdownFormat（））;

    System.out.println（out.toString（））。
}

そうでない場合はSpringBoot、単にSpringWeb、またはJFinal、以下のサンプルディレクトリのデモを参照してくださいを使用する方法

既存の注釈]タブの使用法：

@titleインターフェースのタイトルではなく、デフォルトの読み取りは、インターフェイスコメントに最初の行の内容を記述する場合
@paramインターフェイスパラメータフォーマットへ：「パラメータ名パラメータの説明|（パラメータタイプ）|（必須）」「パラメータの型」時間埋めるために、デフォルトはStringデフォルトの非必須、埋めるために「必要な」時間持っている値は、「必要」必填(Y)、非必填(N)必要|ユーザ名、ユーザ名、ユーザ名、ユーザ名：次のように特定の一般的な形式は 或者 、ユーザー名、ユーザー名| Yユーザ名ユーザ名|オプションの 或者 ユーザ名、ユーザ名| Nユーザ名ユーザ名|文字列名をユーザ名|文字列|必須

現在の方法で上記のパラメータ名が上院に利用できない場合、独自の@paramアノテーションノートそのためのJavaを使用する場合は、コメントとパラメータ名の前にこの問題、XDOCのサポートを解決するために、間違った考えを促すメッセージが表示されます冒号:回避の検出など、::、ユーザー名、ユーザー名にIDEA 或者 のユーザー名、ユーザー名：ユーザー
@paramObjときでDTOで上院自体にその時が、1 @paramに行くに加えて、よりトラブルになり、あなたは、@paramObjを持つオブジェクトDTOのパラメータを指定し、同じ@seeを使用しますが、インターフェイスメソッドをサポートしていることができ@paramObjが表示されます複数の、同時、@ PARAM @paramObj、@ paramObj @paramオブジェクトの属性名とパラメータ名の競合を混合し、どちら@paramにAccountController.javaの参照サンプルの使用優先順位を与えます
@respパラメータは、同じ形式の@paramのリターンを指定します
デモ@respbody指定された戻りデータは、一時的にのみUserController.javaの参照サンプルを用いて、表示のみの目的のためにデータをフォーマットJSONサポート
@respと混合した場合、参照オブジェクトが返さ指定類似@paramObj、しかし一方は上院に、一方が参照される@see、方法は、同じ時刻に、属性名の競合がある、@seeを見ることができ、@respでありますAccountController.javaの参照サンプルを用いて標準化、
@returnは表示のみ、プレーンテキストへのコンテンツの情報の説明を返します

XDOC-のJava 1.1.0リリース、Javaアノテーション純粋なインタフェース文書化ツールを生成します

XDOC Javaベースのアノテーションのインタフェース文書化ツール

なぜXDOC？

どのように使用するには？

1. SpringBoot例：

2.あなたはどのように行うには、オフラインドキュメントを生成したい場合は？

そうでない場合はSpringBoot、単にSpringWeb、またはJFinal、以下のサンプルディレクトリのデモを参照してくださいを使用する方法

既存の注釈]タブの使用法：

おすすめ