使用java注解生成api幫助文檔


1、依賴

<!-- https://mvnrepository.com/artifact/io.github.yedaxia/japidocs -->
<dependency>
<groupId>io.github.yedaxia</groupId>
<artifactId>japidocs</artifactId>
<version>1.2.4</version>
</dependency>

 

2、直接main方法

/**
* @author Administrator
* projectPath: 工程目錄 windows用戶注意用雙斜杠'\\'或者反斜杠'/'
docsPath: 文檔輸出目錄(非必須,默認是${projectPath}/apidocs)
codeTplPath:代碼模版目錄 (非必須,如果你需要自定義生成的代碼才會用到。)
mvcFramework:[spring, play, jfinal, generic](非必須,代碼內部有判斷,如果出現誤判的情況,可以通過這個強制指定)
javaSrcPaths: (非必須)多模塊項目目前是支持 maven 和 gradle 的,如果沒有解析出來的話,可以通過 `addJavaSrcPath` 方法來添加源碼目錄。
plugins:(非必須)自定義實現插件
*/
public class DosFactory {

public static void main(String[] args) {
DocsConfig config = new DocsConfig();
config.setProjectPath("D:\\java_project2\\deerChain_new");
Docs.buildHtmlDocs(config);
System.out.println("導出結束");
}

}

3、如何使用

默認的接口頁面有個bug,就是顯示到一定數量的時候,就不顯示了

如:這樣影響使用的

這樣時候可以修改style.css文件:

div.toc{
overflow: scroll;
width: 25%;
height: 80%;
position: fixed;
right: 0;
margin-right: 10px;
}

這個時候的顯示就比較的友好:帶有滑動條

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM