如何运用smalldoc解决JavaWeb开发中文档书写麻烦的问题
这期内容当中小编将会给大家带来有关如何运用smalldoc解决Java Web开发中文档书写麻烦的问题,文章内容丰富且以专业的角度为大家分析和叙述,阅读完这篇文章希望大家可以有所收获。
创新互联建站是一家专注于成都网站设计、成都做网站与策划设计,夏河网站建设哪家好?创新互联建站做网站,专注于网站建设十多年,网设计领域的专业建站公司;建站业务涵盖:夏河等地区。夏河做网站价格咨询:18980820575
smalldoc-2.3.1
根据 issues更新如下:
修复并优化 source-paths与 packages配置
source-paths默认已经给出当前项目源码路径(即,引入该smalldoc依赖的项目的源码路径 —— System.getProperty("user.dir")
, 2.3.1
修复了不配置路径的空指针错误。
只有当你需要第三方jar包源码 - 或者你的项目是多模块项目需要引入其他模块的源码,才有必要配置 source-paths。
packages配置Controller类
所在的包,会自动递归它们子包。如果没有指定,默认为/
,将扫描源码路径下所有包,建议给出指定包名,提升解析速度。
递归解析返回参数
无论你的返回对象有几层,都可以显示在返回参数表格中,如下图
支持列表或分页接口返回值中List元素结构的解析
修复*Mapping注解
解析异常。
java.lang.ClassCastException: java.lang.Boolean cannot be cast to [Lcom.sun.javadoc.AnnotationValue;
采用注释的方式支持参数是否必须,支持List,Set,数组,和实体参数
普通参数,有且仅在注释后添加
@*
表示必须,否则为可选参数。包括基本类型,基本类型的包装类型,字符串,以及它们的数组,List,Set,同时还有一些库类型
—— 例如 File, MultipartFile实体参数,实体类中的所有字段都可能作为参数被传递,而且每个接口所需要传递字段的要求不尽相同,所以我们不可能在 DTO实体中做标记,这样不仅有代码侵入性,同时也不能满足接口传参的多样性。 实体参数的注释,可以使用
@{f1[*],[f2[*],...]}
这种形式来写,要么代替整个注释,要么放在注释最后。其中
f
表示实体类的某个字段名,通过它 ,smalldoc可以去你的实体类源码中搜寻参数的注释。字段名后添加
*
表示必须,否则为可选参数。如果实体类中的字段没有出现在
@{}
内,该字段将不会作为参数。如果在
@
之前还有其它注释内容,将被忽略。如果你的参数是实体参数,注释结尾却不包含该形式,那么将会打印警告日志,帮你预先定位该问题。
示例如下。
优化参数名展示
优化过后的参数名支持复杂数据结构,比如关联对象,关联集合,Set,List或数组,可直接作为实际参数名进行接口调用。
示例代码
/** * 测试接口 * @param file 文件 * @param bb saddas * @param cc CCCC * @param pp h哈哈是@* * @param cca 擦擦擦黑@{authorId*} * @param content 内容@* * @param oaCopyArray @{authorId*,originalArticleId,categoryId*,paragraph.content} * @param oaCopy @{authorId*,originalArticleId,categoryId*,paragraph.content} * @return data-草稿ID */ @RequestMapping("test_path/action2") public Resulttest(MultipartFile file, Long[] bb , Long cc, List pp, String content, List cca, OriginalArticleCopy[] oaCopyArray, OriginalArticleCopy oaCopy, HttpServletRequest request) { return null; }
文档显示
增加大量断言
如果你的注释不规范,无法生成合理文档,smalldoc将打印警告或直接提示异常
支持离线文档
最初的 smalldoc-antd-react-ui【https://github.com/liuhuagui/smalldoc-antd-react-ui】,采用 React+Fetch
的形式获得文档结构,新版本改用 React+模板引擎
写法,使支持离线文档,你只需要在浏览器中打开文档UI界面,然后 Ctrl+S
保存离线文件。
上述就是小编为大家分享的如何运用smalldoc解决Java Web开发中文档书写麻烦的问题了,如果刚好有类似的疑惑,不妨参照上述分析进行理解。如果想知道更多相关知识,欢迎关注创新互联行业资讯频道。
网站栏目:如何运用smalldoc解决JavaWeb开发中文档书写麻烦的问题
本文URL:http://scyanting.com/article/pgciig.html