Apigcc-非侵入RestDocドキュメント生成ツール

Apigcc-非侵入RestDocドキュメント生成ツール
前言--RestDoc
プログラマーはいつもコードを書きたいだけで、ドキュメントを書きたくないという悩みを持っています.コードは私の考えと魂を表現しています.
Pythonはdocstringという案を提案し、この問題を解決しようとした.つまり、コードを書くと同時に、ドキュメントを書くことができ、コードとドキュメントの一致を保つことができます.docstringははっきり言ってコードの注釈の山です.Pythonのdocstringはhelp関数を通じてフォーマットされたドキュメントを直接出力することができ、このツールの考えはこれと似ています.
コードドキュメント
Apigccは非侵入RestDocドキュメント生成ツールです.ツールは、コードとコメントを分析してドキュメント情報を取得し、RestDocドキュメントを生成します.
maven使用ガイド
1.対応依存の導入

 
        
            com.github.apiggs
            apiggs
            1.6
        

2.mavenプラグインの導入-構成

            
                com.github.apiggs
                apiggs-maven-plugin
                1.6
                
                    
                        compile
                        
                            apiggs
                        
                    
                
                
                    
                    example
                    ${version}
                          ，      
                    
                
            

パラメータの説明

idプロジェクトid,id.htmlなどのファイル

を生成する.

titleドキュメントタイトル

descriptionドキュメント説明

production出力フォルダ、デフォルトはapiggs

out出力ディレクトリ、デフォルトはtarget

sourceソースディレクトリ、現在のプロジェクトのsrc/main/java

をデフォルトで読み出す

dependencyソースコード依存コードディレクトリ

をカンマで区切る

jarソースコード依存jarパケットディレクトリは、

をカンマで区切る.

ignoreは、UserDTO

のようないくつかのタイプを無視します.

versionドキュメントバージョン番号

css設定htmlスタイルシート

注意事項:

mvn compileを実行するにはclean installが必要な場合はプラグインを注記してください衝突があるため

効果を生成