zoukankan      html  css  js  c++  java
  • 使用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;
    25%;
    height: 80%;
    position: fixed;
    right: 0;
    margin-right: 10px;
    }

    这个时候的显示就比较的友好:带有滑动条

  • 相关阅读:
    数学笔记目录
    机器学习笔记目录
    物理学笔记目录
    二阶递推公式的通项公式
    分析Analysis 笔记
    从傅里叶变换到小波变换
    电动力学 期末复习
    电动力学 期中复习
    热学 期中复习
    理论力学第一章 Lagrange方程
  • 原文地址:https://www.cnblogs.com/haoxiu1004/p/10985318.html
Copyright © 2011-2022 走看看