スマート-docの1.7.5リリース、Javaのゼロ注釈ドキュメント生成ツール

スマートドキュメントは、java安らかなAPIドキュメント生成ツール、スマート-docのは、侵襲的な方法注釈の広範な使用は、実装のドキュメントを生成するという従来と同様の闊歩を覆すです。スマート-docの完全なソースコード解析ドキュメントインターフェースベースのインターフェイスを生成するために、完全にゼロノートの侵入を達成、あなただけのJava標準の注釈を書き込むことに従う必要があり、スマート-docのは、あなたが単純明快Markdownを、HTML、AsciiDoc文書を生成することができます。あなたは無数のノートやその他のドキュメントツール闊歩し、強力な侵略汚染の疲れている場合は、スマートドキュメント、それを受け入れるしてください!スマート-docのユーザーとプロジェクトのスターに忘れてはいけないと同じように、あなたのサポートは、スマート-docの力を促進するために続けています。

特長

  • メモは、コメントを書くことだけで、標準的なJavaゼロ学習コストを、ゼロ。
  • 自動的にソースコードのインタフェース定義に基づいて導出、強いリターン構造が得られます。
  • スプリングMVC、スプリングブーツ、春ブーツウェブフラックス(コントローラ表記)のサポート。
  • サポートコーラブル、今後、CompletableFutureおよび他の非同期インターフェイスが返さ導出されます。
  • JavaBeanの上のサポートJSR303仕様パラメータチェック。
  • インターフェイスJSONリクエストパラメータが自動的にJSON形式のシミュレーションパラメータを生成することができます。
  • いくつかの一般的に定義されたフィールドは、有効なアナログを生成することができます。
  • 戻り値JSONの典型的なサポートを生成します。
  • (ジャーパッケージ公表基準を含む)メモフィールド発生のサポート外部ソースからプロジェクトがロードされます。
  • Markdownを、HTML5、Asciidoctor:サポートされているドキュメント形式のさまざまなを生成します。
  • ビューは、オンライン簡単に春ブートサービスの静的なHTML5 APIドキュメントを達成します。
  • 文書データを開き、文書管理システムへの自由なアクセスを実現しています。
  • 検出ツールのコードのコメントは、コメントに洞察力を免れることはできない小さなパートナーを書いていません。
  • インターフェイスのドキュメントへの辞書列挙コード内のさまざまなエラーコードと定義のエクスポートをサポートしています。

闊歩対スマート-docの

  •  スマート-docのないホイールを闊歩を作成するために、これは安らかAPIインタフェースドキュメント生成ツールの再開発の全く異なる概念です。
  •  スマート-docの統合が容易に闊歩よりも、あなたは複数の形式で無料のAPIドキュメントを生成することができます。
  •  スマート-docの完全な注釈は、任意のコードがビジネスの複雑なネストされたオブジェクトが自動的に定義されたフィールド構成を推測入る記述する必要があります。
  • コードのスマート-docの少量、あなたのニーズを満たすことができない場合は、ソースコードに変更を加えることができます。

アップデート

  •  間違ったリストには、ドキュメントのタイトルを最適化し、それが環境の変化に対応したりするので応じて中国語を表示することができます。
  •  プロジェクト内部で生成されたクラスのドキュメントエラーのバグ外瓶を解決します。
  •  リングの依存関係の解析をサポートしています。
  •  変更または使用SpringMvc Sp​​ringBootのContent-Typeの際にアップロードインターフェースが表示され、エラー。
  •  タイトルの値下げなどの項目の設定をサポート。
  • 同じ方法でコメントを修正するためのHTMLリンクはジャンプエラーの原因となりました。
  • AllInOneのデフォルトの自動バージョン番号が上書きされないカバレッジの設定項目を生成するために追加。
  • 文書に新しい列挙辞書エクスポート機能。

アップグレードの推奨

これは、あなたがダウンロードできない場合はただ座っていない、新旧両方のユーザーが最新バージョン(最近更新少し遅い、海外倉庫へのアップグレード、より良い経験にするために、最適化の多くを行っ機能や詳細の一部を追加するために、ユーザーが提出した問題に基づいていますせっかち)。

デモ

デモを使用する簡単な楽しいインターフェイスのドキュメント生成

関連ドキュメント

Javaのウェブ安らかなAPIドキュメントについての再発見

スマート-docの機能は、はじめにを使用しています

公式のプロジェクトのwiki

ユーザー評価

スマートドキュメントのユーザー評価部

  1. 最も強力なドキュメントのコンポーネントは、必須の規範は、それは喜びを触知し、コードを汚染しません!
  2. smartdocは、スマートタイトルの本当に価値がある、元の文書以外のAPI機能を提供しながら、仕様書の準備を強化し、コメントから始めます。

おすすめ

転載: www.oschina.net/news/111149/smart-doc-1-7-5-released