Implementation Way - liuhuagui/smalldoc GitHub Wiki

解析源码文件，通过源码及其中的注释生成文档信息。目前为止注释中使用的Tag都是Java注释的标准Tag，后续可能会添加一些必要的自定义Tag，甚至有可能提供Tag扩展机制 —— 由使用者自定义Tag，同时自定义Tag的处理方式。

一想到生成Java RESTful API文档，首先就是想到Java API文档是如何生成的，所以解析源码的方式没有选择使用com.github.javaparser » javaparser-core或者com.thoughtworks.qdox » qdox，而是选择JDK自己的Javadoc Tool （https://docs.oracle.com/en/java/javase/12/tools/javadoc.html），Javadoc Tool对应的API是Javadoc API（https://docs.oracle.com/en/java/javase/12/docs/api/jdk.javadoc/module-summary.html）

由于作者还在使用Java8，所以该项目的实现完全是基于Javadoc API 旧版

• Package com.sun.tools.javadoc (https://docs.oracle.com/en/java/javase/12/docs/api/jdk.javadoc/com/sun/tools/javadoc/package-summary.html)
• Package com.sun.javadoc (https://docs.oracle.com/en/java/javase/12/docs/api/jdk.javadoc/com/sun/javadoc/package-summary.html)

其中：

Module jdk.javadoc Package com.sun.tools.javadoc This package and its contents are deprecated and may be removed in a future release. See javax.tools.ToolProvider.getSystemDocumentationTool and javax.tools.DocumentationTool for replacement functionality.

Module jdk.javadoc Package com.sun.javadoc Note: The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.

@Deprecated(since="9",forRemoval=true)
public class Main extends Object

可以看出，旧版Javadoc API自 Java9 已经被标记遗弃，在不久的将来将被移除，但是值得庆幸，直到最新的大版本 Java12 该API还未移除，所以使用 Java12 及以前版本的用户可以放心使用，后续作者会提供新版API支持。

UI界面是基于 create-react-app 与 antd 开发的single page application —— smalldoc-antd-react-ui（https://github.com/liuhuagui/smalldoc-antd-react-ui）