精华内容
下载资源
问答
  • javadoc自动生成开发文档

    千次阅读 2009-06-29 15:35:00
    JavaDoc,在 Java 的注释上做文章2007-08-30 09:11... */ 注释若干行 但还有第三种,文档注释: /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ......... * ......... 

     JavaDoc,在 Java 的注释上做文章2007-08-30 09:11
    对于Java注释我们主要了解两种:
      
      // 注释一行

      /* ...... */ 注释若干行

      但还有第三种,文档注释:

      /** ...... */ 注释若干行,并写入 javadoc 文档

      通常这种注释的多行写法如下:

      /**
       * .........
       * .........
       */

      很多人多忽视了这第三种注释,那么这第三种注释有什么用?javadoc 又是什么东西?下面我们就谈谈。

      一. Java 文档和 Javadoc

      Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相

    关类之间的关系,如继承、实现接口、引用等。

      Java 文档全是由一些 html 文件组织起来的,在 SUM 的站点上可以下载它们的压缩包。但是你肯定想不到,这些文档我们可以自己生成。——就此打住,再吊一次胃口。

      安装了 JDK 之后,安装目录下有一个 src.jar 文件或者 src.zip 文件,它们都是以 ZIP 格式压缩的,可以使用 WinZip 解压。解压之后,我们就可以看到分目录放的全是 .java 文件。是了,这

    些就是 Java 运行类的源码了,非常完整,连注释都写得一清二楚……不过,怎么看这些注释都有点似曾相识的感觉?

      这就不奇怪了,我们的迷底也快要揭开了。如果你仔细对比一下 .java 源文件中的文档注释 (/** ... */) 和 Java 文档的内容,你会发现它们就是一样的。Java 文档只是还在格式和排版上下了

    些功夫。再仔细一点,你会发现 .java 源文件中的注释还带有 HTML 标识,如 <B>、<BR>、<Code> 等,在 Java 文档中,该出现这些标识的地方,已经按标识的的定义进行了排版。

      终于真像大白了,原来 Java 文档是来自这些注释。难怪这些注释叫做文档注释呢!不过,是什么工具把这些注释变成文档的呢?

      是该请出 javadoc 的时候了。在 JDK 的 bin 目录下你可以找到 javadoc,如果是 Windows 下的 JDK,它的文件名为 javadoc.exe。使用 javdoc 编译 .java 源文件时,它会读出 .java 源文件

    中的文档注释,并按照一定的规则与 Java 源程序一起进行编译,生成文档。

      介绍 javadoc 的编译命令之前,还是先了解一下文档注释的格式吧。不过为了能够编译下面提到的若干例子,这里先介绍一条 javadoc 命令:

      javadoc -d 文档存放目录 -author -version 源文件名.java

      这条命令编译一个名为 “源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html 就是文档的首页。-author 和 -version 两上选项

    可以省略。
     
    二. 文档注释的格式

      文档注释可以用于对类、属性、方法等进行说明。写文档注释时除了需要使用 /** .... */ 限定之外,还需要注意注释内部的一些细节问题。

      1. 文档和文档注释的格式化

      生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。比如,需要换行时,不是敲入一个回车符,而是写入 <br>,如果要分段,就应

    该在段前写入 <p>。

      因此,格式化文档,就是在文档注释中添加相应的 HTML 标识。

      文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。如
    /**
    * This is first line. <br>
    ***** This is second line. <br>
    This is third line.
    */

      编译输出后的 HTML 源码则是
    This is first line. <br>
    This is second line. <br>
    This is third line.


      前导的 * 号允许连续使用多个,其效果和使用一个 * 号一样,但多个 * 号前不能有其它字符分隔,否则分隔符及后面的 * 号都将作为文档的内容。* 号在这里是作为左边界使用,如上例的第一

    行和第二行;如果没有前导的 * 号,则边界从第一个有效字符开始,而不包括前面的空格,如上例第三行。

      还有一点需要说明,文档注释只说明紧接其后的类、属性或者方法。如下例:
    /** comment for class */
    public class Test {

    /** comment for a attribute */
    int number;

    /** comment for a method */
    public void myMethod() { ...... }

    ......
    }

      上例中的三处注释就是分别对类、属性和方法的文档注释。它们生成的文档分别是说明紧接其后的类、属性、方法的。“紧接”二字尤其重要,如果忽略了这一点,就很可能造成生成的文档错误。


    import java.lang.*;

    /** commnet for class */

    public class Test { ...... }

    // 此例为正确的例子

      这个文档注释将生成正确的文档。但只需要改变其中两行的位置,变成下例,就会出错:
    /** commnet for class */

    import java.lang.*;

    public class Test { ...... }

    // 此例为错误的例子

      这个例子只把上例的 import 语句和文档注释部分交换了位置,结果却大不相同——生成的文档中根本就找不到上述注释的内容了。原因何在?

      “/** commnet for class */”是对 class Test 的说明,把它放在“public class Test { ...... }”之前时,其后紧接着 class Test,符合规则,所以生成的文档正确。但是把它和“import

    java.lang.*;”调换了位置后,其后紧接的就是不 class Test 了,而是一个 import 语句。由于文档注释只能说明类、属性和方法,import 语句不在此列,所以这个文档注释就被当作错误说明省略掉

    了。

     
     2. 文档注释的三部分

      根据在文档中显示的效果,文档注释分为三部分。先举例如下,以便说明。
    /**
    * show 方法的简述.
    * <p>show 方法的详细说明第一行<br>
    * show 方法的详细说明第二行
    * @param b true 表示显示,false 表示隐藏
    * @return 没有返回值
    */
    public void show(boolean b) {
    frame.show(b);
    }

      第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明。列表中属性名或者方法名后面那段说明就是简述。如下图中被红框框选的部分:
     
      简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。如上例中的 “* show 方法的简

    述.”。

      有时,即使正确地以一个点号作为分隔,javadoc 仍然会出错,把点号后面的部分也做为了第一部分。为了解决这个问题,我们可以使用一个 <p> 标志将第二分部分开为下一段,如上例的“* <

    p>show 方法的详细说明第一行 ....”。除此之外,我们也可以使用 <br> 来分隔。

      第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。它在文档中的位置如下图所示:
     
      这部分文档在上例中相应的代码是:
      * show 方法的简述.
      * <p>show 方法的详细说明第一行<br>
      * show 方法的详细说明第二行

      发现什么了?对了,简述也在其中。这一点要记住了,不要画蛇添足——在详细说明部分中再写一次简述哦!

      第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。它在文档中的位置:
     
      第三部分在上例中相应的代码是
      * @param b true 表示显示,false 表示隐藏
      * @return 没有返回值

      除了 @param 和 @return 之外,还有其它的一些特殊标记,分别用于对类、属性和方法的说明……不要推我,我马上就说。
     
    三. 使用 javadoc 标记

      javadoc 标记是插入文档注释中的特殊标记,它们用于标识代码中的特殊引用。javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成。记住了,三个部分——@、标记类型、专用注释引

    用。不过我宁愿把它分成两部分:@ 和标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔,但是我宁愿始终将它们紧挨着写,以减少出错机会。

      javadoc 标记有如下一些:
    标记 用于  作用
    @author 对类的说明  标明开发该类模块的作者
    @version 对类的说明 标明该类模块的版本
    @see 对类、属性、方法的说明 参考转向,也就是相关主题
    @param 对方法的说明 对方法中某参数的说明
    @return  对方法的说明 对方法返回值的说明
    @exception  对方法的说明  对方法可能抛出的异常进行说明

      下面详细说明各标记。

      1. @see 的使用—对应于java  JDK API中的“另请参见”,如下图:
     

      @see 的句法有三种:
      @see 类名
      @see #方法名或属性名--//标记方法或属性时“#”符号必须有
      @see 类名#方法名或属性名

      类名,可以根据需要只写出类名 (如 String) 或者写出类全名 (如 java.lang.String)。那么什么时候只需要写出类名,什么时候需要写出类全名呢?

      如果 java 源文件中的 import 语句包含了的类,可以只写出类名,如果没有包含,则需要写出类全名。java.lang 也已经默认被包含了。这和 javac 编译 java 源文件时的规定一样,所以可以简

    单的用 javac 编译来判断,源程序中 javac 能找到的类,javadoc 也一定能找到;javac 找不到的类,javadoc 也找不到,这就需要使用类全名了。

      方法名或者属性名,如果是属性名,则只需要写出属性名即可;如果是方法名,则需要写出方法名以及参数类型,没有参数的方法,需要写出一对括号。如
    成员类型 成员名称及参数 @see 句法
    属性 number @see number
    属性  count @see count
    方法 count()  @see count()
    方法 show(boolean b) @see show(boolean)
    方法  main(String[] args) @see main(String[])

      有时也可以偷懒:假如上例中,没有 count 这一属性,那么参考方法 count() 就可以简写成 @see count。不过,为了安全起见,还是写全 @see count() 比较好。

      @see 的第二个句法和第三个句法都是转向方法或者属性的参考,它们有什么区别呢?

      第二个句法中没有指出类名,则默认为当前类。所以它定义的参考,都转向本类中的属性或者方法。而第三个句法中指出了类名,则还可以转向其它类的属性或者方法。

      关于 @see 标记,我们举个例说明。由于 @see 在对类说明、对属性说明、对方法说明时用法都一样,所以这里只以对类说明为例。
    /**
    * @see String
    * @see java.lang.StringBuffer
    * @see #str
    * @see #str()
    * @see #main(String[])
    * @see Object#toString()
    */
    public class TestJavaDoc {

    }

      生成的文档的相关部分如下图:
     
      String 和 StringBuffer 都是在 java.lang 包中,由于这个包是默认导入了的,所以这两个类可以直接写类名,也可以写类全名。str、str() 为同名属性和方法,所以方法名需要用 () 区分。

    main 是带参数的方法,所以在 () 中指明了参数类型。toString() 虽然在本类中也有 (从 Object 继承的),但我们是想参考 Object 类的 toString() 方法,所以使用了 Object#toString()。

      奇怪的是,为什么其中只有 str、str() 和 main(String[]) 变成了链接呢?那是因为编译时没有把 java.lang 包或者 Stirng、StringBuffer、Object 三个类的源文件一起加入编译,所以,生成

    的文档没有关于那三个类的信息,也就不可以建立链接了。后面讲解 javadoc 编译命令的时候还会详细说明。

      上例中如果去把类中的 str 属性去掉,那么生成的文档又会有什么变化呢?你会发现,原来是 str, str(),而现在变成了 str(), str(),因为 str 属性已经没有了,所以 str 也表示方法 str()

    。 

    2. 使用 @author、@version 说明类

      这两个标记分别用于指明类的作者和版本。缺省情况下 javadoc 将其忽略,但命令行开关 -author 和 -version 可以修改这个功能,使其包含的信息被输出。这两个标记的句法如下:

      @author 作者名
      @version 版本号

      其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效,生成的文档中只会显示第一次使用 @version 指明

    的版本号。如下例
    /**
    * @author Fancy
    * @author Bird
    * @version Version 1.00
    * @version Version 2.00
    */
    public class TestJavaDoc {

    }

      生成文档的相关部分如图:
     
      从生成文档的图示中可以看出,两个 @author 语句都被编译,在文档中生成了作者列表。而两个 @version 语句中只有第一句被编译了,只生成了一个版本号。

      从图上看,作者列表是以逗号分隔的,如果我想分行显示怎么办?另外,如果我想显示两个以上的版本号又该怎么办?

      ——我们可以将上述两条 @author 语句合为一句,把两个 @version 语句也合为一句:

      @author Fancy<br>Bird
      @version Version 1.00<br>Version 2.00

      结果如图:
     
      我们这样做即达到了目的,又没有破坏规则。@author 之后的作者名和 @version 之后的版本号都可以是用户自己定义的任何 HTML 格式,所以我们可以使用 <br> 标记将其分行显示。同时,在

    一个 @version 中指明两个用 <br> 分隔的版本号,也没有破坏只显示第一个 @version 内容的规则。
     
    3. 使用 @param、@return 和 @exception 说明方法

      这三个标记都是只用于方法的。@param 描述方法的参数,@return 描述方法的返回值,@exception 描述方法可能抛出的异常。它们的句法如下:

      @param 参数名 参数说明
      @return 返回值说明
      @exception 异常类名 说明

      每一个 @param 只能描述方法的一个参数,所以,如果方法需要多个参数,就需要多次使用 @param 来描述。

      一个方法中只能用一个 @return,如果文档说明中列了多个 @return,则 javadoc 编译时会发出警告,且只有第一个 @return 在生成的文档中有效。

      方法可能抛出的异常应当用 @exception 描述。由于一个方法可能抛出多个异常,所以可以有多个 @exception。每个 @exception 后面应有简述的异常类名,说明中应指出抛出异常的原因。需要注

    意的是,异常类名应该根据源文件的 import 语句确定是写出类名还是类全名。   示例如下:
    public class TestJavaDoc {

    /**
    * @param n a switch
    * @param b excrescent parameter
    * @return true or false
    * @return excrescent return
    * @exception java.lang.Exception throw when switch is 1
    * @exception NullPointerException throw when parameter n is null
    */
    public boolean fun(Integer n) throws Exception {
    switch (n.intValue()) {
    case 0:
    break;
    case 1:
    throw new Exception("Test Only");
    default:
    return false;
    }
    return true;
    }

    }

      使用 javadoc 编译生成的文档相关部分如下图:
     
      可以看到,上例中 @param b excrescent parameter 一句是多余的,因为参数只是一个 n,并没有一个 b 但是 javadoc 编译时并没有检查。因此,写文档注释时一定要正确匹配参数表与方法中正

    式参数表的项目。如果方法参数表中的参数是 a,文档中却给出对参数 x 的解释,或者再多出一个参数 i,就会让人摸不着头脑了。@exception 也是一样。

      上例程序中并没有抛出一个 NullPointerException,但是文档注释中为什么要写上这么一句呢,难道又是为了演示?这不是为了演示描述多余的异常也能通过编译,而是为了说明写异常说明时应考

    运行时 (RunTime) 异常的可能性。上例程序中,如果参数 n 是给的一个空值 (null),那么程序会在运行的时候抛出一个 NullPointerException,因此,在文档注释中添加了对 NullPointerException

    的说明。

      上例中的 @return 语句有两个,但是根据规则,同一个方法中,只有第一个 @return 有效,其余的会被 javadoc 忽略。所以生成的文档中没有出现第二个 @return 的描述。

      讲到这里,该怎么写文档注释你应该已经清楚了,下面就开始讲解 javadoc 的常用命令。
     
    四. javadoc 命令

      运行 javadoc -help 可以看到 javadoc 的用法,这里列举常用参数如下:

      用法:

       javadoc [options] [packagenames] [sourcefiles]

      选项:

       -public 仅显示 public 类和成员
       -protected 显示 protected/public 类和成员 (缺省)
       -package 显示 package/protected/public 类和成员
       -private 显示所有类和成员
       -d <directory> 输出文件的目标目录
       -version 包含 @version 段
       -author 包含 @author 段
       -splitindex 将索引分为每个字母对应一个文件
       -windowtitle <text> 文档的浏览器窗口标题

      javadoc 编译文档时可以给定包列表,也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下:

      fancy.Editor
      fancy.Test
      fancy.editor.ECommand
      fancy.editor.EDocument
      fancy.editor.EView

      这里有两个包 (fancy 和 fancy.editor) 和 5 个类。那么编译时 (Windows 环境) 可以使用如下 javadoc 命令:

      javadoc fancy/Test.java fancy/Editor.java fancy/editor/ECommand.java fancy/editor/EDocument.java fancy/editor/EView.java

      这是给出 java 源文件作为编译参数的方法,注意命令中指出的是文件路径,应该根据实际情况改变。也可以是给出包名作为编译参数,如:

      javadoc fancy fancy.editor

      用浏览器打开生成文档的 index.html 文件即可发现两种方式编译结果的不同,如下图:
     
      用第二条命令生成的文档被框架分成了三部分:包列表、类列表和类说明。在包列表中选择了某个包之后,类列表中就会列出该包中的所有类;在类列表中选择了某个类之后,类说明部分就会显示

    出该类的详细文档。而用第一条命令生成的文档只有两部分,类列表和类说明,没有包列表。这就是两种方式生成文档的最大区别了。

      两种方式编译还有一点不同,

      下面再来细说选项。

      -public、-protected、-package、-private 四个选项,只需要任选其一即可。它们指定的显示类成员的程度。它们显示的成员多少是一个包含的关系,如下表:

      -private (显示所有类和成员)
      -package (显示 package/protected/public 类和成员)
      -protected (显示 protected/public 类和成员)
      -public (仅显示 public 类和成员)

      -d 选项允许你定义输出目录。如果不用 -d 定义输出目录,生成的文档文件会放在当前目录下。-d 选项的用法是

      -d 目录名

      目录名为必填项,也就是说,如果你使用了 -d 参数,就一定要为它指定一个目录。这个目录必须已经存在了,如果还不存在,请在运行 javadoc 之前创建该目录。

      -version 和 -author 用于控制生成文档时是否生成 @version 和 @author 指定的内容。不加这两个参数的情况下,生成的文档中不包含版本和作者信息。

      -splitindex 选项将索引分为每个字母对应一个文件。默认情况下,索引文件只有一个,且该文件中包含所有索引内容。当然生成文档内容不多的时候,这样做非常合适,但是,如果文档内容非常

    多的时候,这个索引文件将包含非常多的内容,显得过于庞大。使用 -splitindex 会把索引文件按各索引项的第一个字母进行分类,每个字母对应一个文件。这样,就减轻了一个索引文件的负担。

      -windowtitle 选项为文档指定一个标题,该标题会显示在窗口的标题栏上。如果不指定该标题,而默认的文档标题为“生成的文档(无标题)”。该选项的用法是:

      -windowtitle 标题

      标题是一串没有包含空格的文本,因为空格符是用于分隔各参数的,所以不能包含空格。同 -d 类似,如果指定了 -windowtitle 选项,则必须指定标题文本。

      到此为止,Java 文档和 javadoc 就介绍完了。javadoc 真的能让我们在 Java 注释上做文章——生成开发文

     

    自己积累:
    1.不能在返回类型为void的方法中使用@return标记
    2.在无参的函数前不需要写@param标记,如果写了,则“无参数。”会被认为是参数名。

    展开全文
  • devdocs:最新的自动生成开发文档
  • php注释自动生成api文档
  • 主要介绍了eclipse中自动生成javadoc文档的方法,是实用eclipse开发Java程序时非常实用的技巧,对于进行Java项目开发具有一定的参考借鉴价值,需要的朋友可以参考下
  • 对于Javadoc的自动生成网住文档的具体使用方法
  • tp5框架开发的restful API接口自动生成文档源码
  • 主要实现在对应数据库中表的基类代码的自动生成,包括生成属性、添加、修改、删除、查询、存在性、Model 类构造等基础代码片断,支持不同3种架构代码生成,使程序员可以节省大量机械录入的时间和重复劳动,而将精力...
  • wpf自动生成pdf文档

    2015-07-09 11:32:32
    在wpf开发过程中,也常用到pdf文档,这是自动生成pdf文档demo
  • 自动生成接口文档之JApiDocs教程

    万次阅读 2020-12-09 16:06:20
    所以,自动生成接口文档的工具就出现了。大家最熟悉的应该就是swagger了,我并没有使用过swagger,虽然它比较健壮,稳定。但是由于它的规范很复杂,需要将代码变动的地方也很多。所以我使用了JApiDocs这个工具来为我...

    JApiDocs教程

    前言

    • 作为一名优秀的程序员来说,由于涉及到要与前端进行对接,所以避免不了的就是写接口文档。写完接口文档,一旦代码返回结果,参数等出现变动,接口文档还得随之改动,十分麻烦,违背了我们简单,快速,低bug的开发初衷。
    • 所以,自动生成接口文档的工具就出现了。大家最熟悉的应该就是swagger了,我并没有使用过swagger,虽然它比较健壮,稳定。但是由于它的规范很复杂,需要将代码变动的地方也很多。所以我使用了JApiDocs这个工具来为我的项目自定生成接口文档。
    • 它的优点就是,相对于springboot以及ssm开发模式而言,它的改动都不是很大,规范一下代码,就可以轻松获取接口文档了。
    • 问题:参数为实体类对象时,直接显示对象里的所有字段。而真正使用的字段只有一部分。大体没什么毛病,界面也很简洁美观。大家如果有解决参数精准显示的想法,可以在评论区一起讨论下。

    一、Maven依赖

    <!--  JApiDocs  -->
    <dependency>
       <groupId>io.github.yedaxia</groupId>
       <artifactId>japidocs</artifactId>
       <version>1.4.3</version>
    </dependency>
    

    二、代码规范

    为什么要进行代码规范?

    • JApiDocs会根据固定的格式,来为我们解析出相应的接口文档,相对比与swagger来说,JApiDocs的格式相对来说是很简单的,springboot开发的项目使用起来改动不大,同时还能使我们的代码规范,简洁,一致。所以我们只要遵循以下几点就能得到规整的接口文档了。

    以下都是针对于controller模块:

    1. 分组名称 @description

    注:官方文档中注明分组名称@description,但是实际应用中不需要加入注解,像下例所示,直接写注释即可。(类上写不写都行,方法上如果加上@description反而不显示)
    例:

    /**
     * 用户接口
     */
    /*注意:这里不能空行,否则注释名无法显示*/
    @RequestMapping("test")
    @Controller
    public class testInterface {
    
        @Autowired
        private RoleService roleService;
        /**
         * 保存用户
         */
        @PostMapping("advice")
        public RoleInfo getAdviceList(String docId){
            return roleService.FindRoleBydocId(docId);
        }
    
    }
    

    效果图:
    在这里插入图片描述

    2. 接口参数(JApiDocs 会通过 @param 来寻找接口参数和进一步解析参数的内容)

    注:注释一定要放在@注解的上面,否则参数会不显示

    (1)格式:接口参数 @param 字段 字段解释

    例:

    /**
         * @description 保存用户
         * @param docId  医生id
        */
    @PostMapping("advice")
    public RoleInfo getAdviceList(String docId){
        return roleService.FindRoleBydocId(docId);
    }
    

    效果图:
    在这里插入图片描述

    (2)在相应的bean对象里添加注释

    例:

    public class RemindInfo implements Serializable {
      private long remindId;  //提醒id
      private String remindContent;  //提醒信息
      private java.sql.Timestamp remindTime;  //提醒时间
    }
    

    效果图:
    在这里插入图片描述

    注:字段后的注释一定都要写上,否则会报下面的错误:
    在这里插入图片描述

    (3)使用@RequestBody 注解json格式的参数

    效果图:
    在这里插入图片描述

    3. 返回对象

    (1)@RestController 或 @ResponseBody

    返回json数据类型
    例:

    /**
     * 用户接口
     */
    @RequestMapping("/test")
    @RestController
    public class testInterface {
    
        @Autowired
        private RoleService roleService;
        /**
         * 保存用户
         * @param docId  医生id
         */
        @ApiDoc
        @PostMapping("advice")
        public RoleInfo getAdviceList(String docId){
            return roleService.FindRoleBydocId(docId);
        }
    
    }
    

    效果图:
    在这里插入图片描述

    (2)请求类型

    @PostMapping("advice")/@GetMapping("advice")
        public RoleInfo getAdviceList(String docId){
            return roleService.FindRoleBydocId(docId);
        }
    

    效果图: 在这里插入图片描述
    在这里插入图片描述在这里插入图片描述

    没有指定具体类型时:

    注:返回参数不能指向不明,如:Object,否则会报
    Exception in thread “main” io.github.yedaxia.apidocs.exception.JavaFileNotFoundException: Cannot find java file 的错误。

    4、高级配置

    (1)@ApiDoc

    a.实现

    JApiDocs 默认只导出声明了@ApiDoc的接口,我们前面通过设置config.setAutoGenerate(Boolean.TRUE) 来解除了这个限制。如果你不希望把所有的接口都导出,你可以把autoGenerate设置关闭,在相关Controller类或者接口方法上通过添加@ApiDoc来确定哪些接口需要导出。

    b.其他设置

    result: 这个可以直接声明返回的对象类型,如果你声明了,将会覆盖SpringBoot的返回对象
    stringResult:返回字符串,在返回结果比较简单,而不想创建一个专门的返回类,则可以考虑使用这个属性。
    url: 请求URL,扩展字段,用于支持非SpringBoot项目
    method: 请求方法,扩展字段,用于支持非SpringBoot项目

    例:

    @ApiDoc(result = AdminVO.class, url = "/api/v1/admin/login2", method = "post")
    
    stringResult 实例,在文档中将会自动格式化json字符串:
    @ApiDoc(stringResult = "{code: 0, data: 'success'}")
    @GetMapping(value = "custom-json")
    public Map customJsonResult(){}
    

    (2)@Ignore (忽略Controller,接口,字段)

    例:忽略Controller

    @Ignore
    public class UserController { 
    
    }
    

    三、配置参数

    在任意一个main入口执行下面的代码:

    DocsConfig config = new DocsConfig();
    config.setProjectPath("your springboot project path"); // 项目根目录
    config.setProjectName("ProjectName"); // 项目名称
    config.setApiVersion("V1.0");       // 声明该API的版本
    config.setDocsPath("your api docs path"); // 生成API 文档所在目录
    config.setAutoGenerate(Boolean.TRUE);  // 配置自动生成
    Docs.buildHtmlDocs(config); // 执行生成文档
    

    执行结果类似效果图:
    在这里插入图片描述

    四、导出格式

    (1)Markdown

      config.addPlugin(new MarkdownDocPlugin());
    

    (2)导出 pdf 或者 word

    可以通过 pandoc 把 markdown 格式转成 pdf 或者 word 格式。

    五、自定义代码模板

    JApiDocs 除了支持文档导出,目前也支持生成了 Android 和 iOS 的返回对象代码,对应 Java 和 Object-C 语言, 如果你想修改代码模板,可以通过以下的方法:

    (1)定义代码模板

    把源码中library项目resources目录下的代码模板拷贝一份,其中,IOS_表示 Object-C 代码模板,JAVA_开头表示 Java代码, 模板中类似${CLASS_NAME}的符号是替换变量,具体含义你可以结合生成的代码进行理解,然后按照你想要的代码模板进行修改即可。

    (2)选择新的模板

    通过DocsConfig配置模板路径替换成新的模板:

    docsConfig.setResourcePath("模板路径");
    

    六、添加更多功能

    JApiDocs 提供了插件接口,你可以通过插件接口来实现更多丰富的功能,下面介绍如何添加插件:

    (1)实现 IPluginSupport 接口

    public class CustomPlugin implements IPluginSupport{
          @Override
          public void execute(List<ControllerNode> controllerNodeList){
             // 实现你自己的功能需求
          }
    }
    

    (2)添加插件

     config.addPlugin(new CustomPlugin());
    

    七、问题的解决

    1、如何排查错误?

    关闭自动生成config.setAutoGenerate(Boolean.FALSE),使用@ApiDoc 来一个个接口导出排查问题。

    2、多模块找不到相关类源码?

    如果源码路径没有全部识别出来,可以通过config.addJavaSrcPath来添加模块的源码路径,注意要添加到src/main/java这一级。

    八、自定义注释模板

    这是我针对JApiDocs,对我的模板进行了一定的调整,以方便对JApiDocs的使用,大家可以参考一下。

    (1)Live Templates

      /**
     * TODO
     * @create_by: 作者名字
     * @create_time: $date$ $time$
     * $params$
     * @return $return$
     */
    

    (2)File Header

    /**
     * @Author 作者名字
     * @Date ${DATE} ${TIME}
     * @description  ${description}
     * @Version 1.0
     */
    

    具体如何实现自定义方法注释,类注释。可以参考下面的文章:

    https://blog.csdn.net/qq_38675373/article/details/105886922

    JApiDocs官方文档地址:

    https://japidocs.agilestudio.cn/#/

    展开全文
  • 慢慢发现,该部分工作都是简单粗暴无营养的,所以需要开发工具来自动生成代码结构的文档说明。 1.2 设计 单文件【CS】操作流程: 选择单文件(.cs)文件 -> 选择输出内容 -> 选择单文件-> 计算 ->打印日志 ->...

    1.1 需求

    由于最近在写C#代码时,需要编写代码结构说明文档,在文档当中把类中的属性和方法进行编写。慢慢发现,该部分工作都是简单粗暴无营养的,所以需要开发工具来自动化生成代码结构的文档说明。

    1.2 设计

    单文件【CS】操作流程: 选择单文件(.cs)文件 -> 选择输出内容 -> 选择单文件-> 计算 ->打印日志 ->生成结构文档。

    多文件【CS】操作流程:选择文件夹 -> 选择输出内容 -> 选择单文件-> 计算 ->打印日志 ->生成结构文档


    1.3 实现效果

    单文件【CS】操作界面:


    多文件【CS】操作界面:



    导出文件效果:


    1.4 工具下载

        下载地址 : http://download.csdn.net/download/chr23899/10151324 

        



    展开全文
  • } } } 6、java代码,将数据写入到word文档中并生成表格的样例代码。 package com.xmbestone.tlb.manage.util; import java.awt.Color; import java.io.FileNotFoundException; import java.io.FileOutputStream; ...

    1、输出表结果,表结构可自己通过代码调整,简单但是有时候很实用,可以节省大量的时间,主要思路:

    a 在java代码中,通过数据库查询语句获取所有表名和表名备注信息。

    b 通过表名获取某张表的所有字段说明。

    c 整理查询出来的结果,写入到word文档中。

                
     
              输出表结果

    2、主要数据库查询语句说明

    a、查询数据库所有表名和表名说明,查询语句如下

    select table_name,table_comment from information_schema.tables where table_schema = 'xmsa_trace'
              
     

    b、查询数据库某张表的所有字段说明,查询语句如下

    SHOW FULL FIELDS FROM xmsa_trace.area_classify;
     
               

    3、java代码中,通过sql语句查询,查询上述两个结果,不同的框架查询方法不同,以下的是springmvc+mybatis框架的代码,详细代码见文章结尾。

              
     

    4、将查询出来的结果整理,写入word,并生成表格

     

     

     

     
     
     
     

    5、写 入word表格的详细代码,需导入itext-2.1.7.jar  itext-asian-5.2.0.jar  itext-rtf-2.1.7.jar 三个架包

       

    package com.xmbestone.tlb.manage.util;
    
    import java.awt.Color;
    
    import java.io.FileNotFoundException;
    
    import java.io.FileOutputStream;import java.io.IOException;import java.util.List;
    
    import java.util.Map;import org.springframework.beans.factory.annotation.Autowired;
    
    import org.springframework.stereotype.Service;
    
    import com.lowagie.text.Cell;import com.lowagie.text.Document;
    
    import com.lowagie.text.DocumentException;
    
    import com.lowagie.text.Font;import com.lowagie.text.PageSize;
    
    import com.lowagie.text.Paragraph;
    
    import com.lowagie.text.Table;
    
    import com.lowagie.text.rtf.RtfWriter2;
    
    import com.xmbestone.tlb.manage.service.business.IBusinessSupplierService;
    
    /** * 创建word文档 步骤: 1,建立文档 2,创建一个书写器 3,打开文档 4,向文档中写入数据 5,关闭文档 */
    
    @Service("dateToWordUtil")public class DateToWordUtil {@Autowiredprivate IBusinessSupplierService businessSupplierService;
    
    /** * @param args * @throws Exception */public void toWord(List> listAll) throws Exception {// 创建word文档,并设置纸张的大小Document document = new Document(PageSize.A4);
    
    try {// 创建word文档RtfWriter2.getInstance(document, new FileOutputStream("E:/word5.doc"));
    
    document.open();// 设置文档标题
    
    Paragraph ph = new Paragraph();
    
    Font f = new Font();
    
    Paragraph p = new Paragraph("数据库表设计文档", new Font(Font.NORMAL, 24,Font.BOLDITALIC, new Color(0, 0, 0)));
    
    p.setAlignment(1);
    
    document.add(p);
    
    ph.setFont(f);/* * 创建表格 通过查询出来的表遍历 */
    
    for (int i = 0; i < listAll.size(); i++) {
    
    // 表名
    
    String table_name = (String) listAll.get(i).get("table_name");
    
    // 表说明
    
    String table_comment = (String) listAll.get(i).get("table_comment");
    
    String sql = "SHOW FULL FIELDS FROM xmsa_trace." + table_name+ " ";
    
    //获取某张表的所有字段说明
    
    List> list = businessSupplierService.listMap(sql);
    
    //构建表说明
    
    String all = "" + (i + 1) + " 表名:" + table_name + " "+ table_comment + "";
    
    //创建有6列的表格
    
    Table table = new Table(6);
    
    document.add(new Paragraph(""));
    
    table.setBorderWidth(1);
    
    // table.setBorderColor(Color.BLACK);
    
    table.setPadding(0);
    
    table.setSpacing(0);
    
    /*
    
    * 添加表头的元素,并设置表头背景的颜色
    
    */
    
    Color chade = new Color(176, 196, 222);
    
    Cell cell = new Cell("序号");// 单元格
    
    cell.setBackgroundColor(chade);
    
    cell.setHeader(true);
    
    // cell.setColspan(3);//设置表格为三列
    
    // cell.setRowspan(3);//设置表格为三行
    
    table.addCell(cell);
    
    cell = new Cell("字段名");// 单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("类型");// 单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("是否为空");// 单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("主键");// 单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("字段说明");// 单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    table.endHeaders();// 表头结束
    
    // 表格的主体,
    
    for (int k = 0; k < list.size(); k++) {
    
    //获取某表每个字段的详细说明
    
    String Field = (String) list.get(k).get("Field");
    
    String Type = (String) list.get(k).get("Type");
    
    String Null = (String) list.get(k).get("Null");
    
    String Key = (String) list.get(k).get("Key");
    
    String Comment = (String) list.get(k).get("Comment");
    
    table.addCell((k + 1) + "");
    
    table.addCell(Field);
    
    table.addCell(Type);
    
    table.addCell(Null);
    
    table.addCell(Key);
    
    table.addCell(Comment);
    
    }
    
    Paragraph pheae = new Paragraph(all);
    
    //写入表说明
    
    document.add(pheae);
    
    //生成表格
    
    document.add(table);
    
    }
    
    document.close();
    
    } catch (FileNotFoundException e) {
    
    e.printStackTrace();
    
    } catch (DocumentException e) {
    
    e.printStackTrace();
    
    } catch (IOException e) {
    
    e.printStackTrace();
    
    }
    
    }
    
    }

    6、java代码,将数据写入到word文档中并生成表格的样例代码。

    package com.xmbestone.tlb.manage.util;
    
    import java.awt.Color;
    
    import java.io.FileNotFoundException;
    
    import java.io.FileOutputStream;
    
    import java.io.IOException;
    
    import com.lowagie.text.Cell;
    
    import com.lowagie.text.Document;
    
    import com.lowagie.text.DocumentException;
    
    import com.lowagie.text.Font;
    
    import com.lowagie.text.PageSize;
    
    import com.lowagie.text.Paragraph;
    
    import com.lowagie.text.Table;
    
    import com.lowagie.text.pdf.BaseFont;
    
    import com.lowagie.text.rtf.RtfWriter2;
    
    /**
    
    * 创建word文档 步骤:
    
    * 1,建立文档
    
    * 2,创建一个书写器
    
    * 3,打开文档
    
    * 4,向文档中写入数据
    
    * 5,关闭文档
    
    */
    
    public class WordDemo {
    
    public WordDemo() {
    
    }
    
    /**
    
    * @param args
    
    */
    
    public static void main(String[] args) {
    
    // 创建word文档,并设置纸张的大小
    
    Document document = new Document(PageSize.A4);
    
    try {
    
    RtfWriter2.getInstance(document,
    
    new FileOutputStream("E:/word5.doc"));
    
    document.open();
    
    //设置合同头
    
    Paragraph ph = new Paragraph();
    
    Font f  = new Font();
    
    Paragraph p = new Paragraph("数据库表设计文档", new Font(Font.NORMAL, 24, Font.BOLDITALIC, new Color(0, 0, 0)) );
    
    p.setAlignment(1);
    
    document.add(p);
    
    ph.setFont(f);
    
    // 设置中文字体
    
    // BaseFont bfFont =    BaseFont.createFont("STSongStd-Light",  "UniGB-UCS2-H",BaseFont.NOT_EMBEDDED);
    
    // Font chinaFont = new Font();
    
    /*
    
    * 创建有三列的表格
    
    */
    
    for(int i=0;i<5;i++){
    
    Table table = new Table(6);
    
    document.add(new Paragraph(""));
    
    table.setBorderWidth(1);
    
    // table.setBorderColor(Color.BLACK);
    
    table.setPadding(0);
    
    table.setSpacing(0);
    
    /*
    
    * 添加表头的元素
    
    */
    
    Color chade = new Color(176, 196, 222);
    
    Cell cell = new Cell("序号");//单元格
    
    cell.setBackgroundColor(chade);
    
    cell.setHeader(true);
    
    //        cell.setColspan(1);//设置表格为三列
    
    //        cell.setRowspan(1);//设置表格为三行
    
    table.addCell(cell);
    
    cell = new Cell("字段名");//单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("类型");//单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("是否为空");//单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("主键");//单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    cell = new Cell("字段说明");//单元格
    
    cell.setBackgroundColor(chade);
    
    table.addCell(cell);
    
    table.endHeaders();// 表头结束
    
    // 表格的主体
    
    table.addCell("1,1");
    
    table.addCell("1,2");
    
    table.addCell("1,3");
    
    table.addCell("1,4");
    
    table.addCell("1,5");
    
    table.addCell("1,6");
    
    table.addCell("你好啊");
    
    table.addCell("你好啊");
    
    table.addCell("你好啊");
    
    table.addCell("你好啊");
    
    table.addCell("你好啊");
    
    table.addCell("你好啊");
    
    document.add(new Paragraph("表一"));
    
    document.add(table);
    
    }
    
    document.close();
    
    } catch (FileNotFoundException e) {
    
    e.printStackTrace();
    
    } catch (DocumentException e) {
    
    e.printStackTrace();
    
    } catch (IOException e) {
    
    e.printStackTrace();
    
    }
    
    }
    
    }

     

    展开全文
  • go实践之swagger自动生成api文档

    万次阅读 2018-12-08 21:12:45
    文章目录go实践之swagger自动生成api文档1、安装需要用到的包2、接口代码支持swagger3、 生成swagger接口 go实践之swagger自动生成api文档 作为一个后端开发,给前端提供api接口是必须的。手动去写文档不是一个...
  • 自动生成API文档-apidoc

    千次阅读 2018-08-20 18:51:43
    对于一个后台开发者编写接口文档是必不可少的一件事,但是手动编写又很麻烦,网上出现了很多自动生成的API文档框架,本篇文章就来介绍一下apidoc的在node开发过程中的基本使用。 用法 npm安装 对于我们在...
  • 介绍了MATLAB/simulink平台下生成嵌入式实时代码的过程,介绍了TLC文件的编写过程。
  • Swagger2 自动生成接口文档

    万次阅读 2018-06-12 10:29:54
    公司服务器程序需要给移动端App等提供数据访问接口,之前接口信息都是使用word文档提供给前端人员使用,后来发现后台稍微修改一下,就需要更改一次文档,有时候修改不及时或者遗漏,容易造成前端和后台接口不一致,...
  • webAPI 自动生成帮助文档

    千次阅读 2017-02-17 09:44:17
    之前在项目中有用到webapi对外提供接口,发现在项目中有根据webapi的方法和注释自动生成帮助文档,还可以测试webapi方法,功能很是强大,现拿出来与大家分享一下。 先看一下生成的webapi文档。 1、下图展示的...
  • 自动生成接口文档的三种方式

    千次阅读 2020-12-01 18:00:04
    那么有没有方法能自动生成接口文档来提高前后端的开发效率呢? 自定义动态生成接口文档,手动部署 在对外暴露的接口上添加一套自定义注解。注解可指定接口名称,请求 url,请求方式,请求参数,请求参数类型,返回...
  • [技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档     Doxygen本来是一个很好的工具,可是我感觉在mac系统下,如果用doxygen最后生成的CHM文件感觉就不是那么恰当,应为本身CHM是微软的...
  • iOS开发----IOS项目自动生成技术文档

    千次阅读 2014-02-09 11:14:14
    一般的开发工具都会提供类似集成的功能,比如Java语言本身就自带javadoc命令,可以从源码中抽取文档,几个配置,几条命令就搞定了。 Xcode工具本身不具备这样的功能,但是我们通过一些插件和工具来达到这个目的...
  • 自己开发的,可以通过在线编辑JSON数据自动生成HTML API说明文档,分享一下!
  • 使用swagger自动生成文档

    千次阅读 2019-01-10 14:31:08
    后端的同学肯定会经常碰到这样的需求:这个接口开发完了,但是前端和测试不知道怎么联调和测试,你写一个文档给他们吧,这种要求实在是很细碎,有没有一种方法能自动生成文档从而减少沟通时间呢? swagger是一个开源...
  • 一份关于使用Swagger自动生成API说明文档的开发文档
  • v4.1.2版更新震撼发布,功能更加强大,速度过来围观,此次版本更新如下: 1、随着程序的功能越来越强大,原来的定位和设计已经无法满足更高的... 2、新增快速生成数据库设计文档和批量生成数据库设计文档的功能。 ...
  • java注释及自动生成文档

    千次阅读 2017-12-17 13:47:48
    单行注释 ...从程序源代码中抽取文档注释形成一个和源代码配套的API帮助文档,在编写程序时以文档标签做注释,在编写完成后,通过Javadoc可以自动生成程序的开发文档 简单实用命令:javadoc -d 生成目标路
  • 用NDOC自动生成.NET文档

    千次阅读 2012-07-25 16:48:13
    NDoc使用Visual Studio.NET开发过程中生成的程序集和XML文档生成一些格式象Visual Studio.NET和.NET Frmaework SDK在线帮助文档那样的一些编译后的HTML帮助文档。它是一个OpenSource的项目,在...
  • TableGo v5.0.0版更新震撼发布,功能更加强大,速度过来围观,此次版本更新如下: 1、UI界面大改版,功能模块重新梳理,以满足... 3、新增根据数据库表生成SQL功能,可根据配置自动生成各种SQL。 4、修改优化根...
  • SpringBoot整合Swagger自动生成API文档

    千次阅读 2018-07-27 14:38:54
    目录 1.引入Swagger依赖(我这里使用的2.2.2版本,尽量别使用新版本,不稳定) ...Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件,相比于传统的postman插件,其优点在于: 前后端可以分离开发 ...
  • SpringBoot结合swagger自动生成API文档

    千次阅读 2018-09-06 11:51:17
    Web开发常采用前后端分离的方式。前后端通过API进行交互,在Swagger UI中,前后端人员能够直观预览并且测试API,方便前后端人员同步开发。...springfox-swagger2组件帮助我们自动生成描述API的json文件,...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 381,244
精华内容 152,497
关键字:

自动生成开发文档