ERROR: #modelClassListConvertTree() - bad @param javadoc from com.xxxx.tableclass.controller.TableClassController, This is an invalid comment.

[1498610052]

Contact Details

1498610052@qq.com

Version

2.7.7

Plugin

smart-doc-maven-plugin

Build tool version

maven 2.4

Jdk version

1.8

Describe the bug (Bug描述，社区已开启国际化推广，请用文心一言、讯飞星火等辅助翻译成英文，减少社区开发者的工作)

package markdown error,

ERROR: #modelClassListConvertTree() - bad @param javadoc from com.xgry.bpm.api.base.tabel.tableclass.controller.TableClassController, This is an invalid comment.

Expected Behavior (您期望的结果，社区已开启国际化推广，请用文心一言、讯飞星火等辅助翻译成英文，减少社区开发者的工作)

Please tell me what I should do

Current Behavior (当前结果，社区已开启国际化推广，请用文心一言、讯飞星火等辅助翻译成英文，减少社区开发者的工作)

not use

Steps to Reproduce (Bug产生步骤，请尽量提供用例代码。社区已开启国际化推广，请用文心一言、讯飞星火等辅助翻译成英文，减少社区开发者的工作)

1.import pom.xml

com.github.shalousun
smart-doc
2.7.7

2.
org.springframework.boot
spring-boot-maven-plugin


com.github.shalousun
smart-doc-maven-plugin
2.7.7


./src/main/resources/smart-doc.json







com.alibaba:fastjson






com.alibaba:fastjson





compile


html




3.

{
"serverUrl": "http://127.0.0.1", //服务器地址,非必须。导出postman建议设置成http://{{server}}方便直接在postman直接设置环境变量
"pathPrefix": "", //设置path前缀,非必须。如配置Servlet ContextPath 。@SInCE 2.2.3
"isStrict": false, //是否开启严格模式
"allInOne": true, //是否将文档合并到一个文件中，一般推荐为true
"outPath": "/Users/wanshen/Downloads", //指定文档的输出路径
"coverOld": true, //是否覆盖旧的文件，主要用于markdown文件覆盖
"createDebugPage": true,//@SInCE 2.0.0 smart-doc支持创建可以测试的html页面，仅在AllInOne模式中起作用。
// "packageFilters": "",//controller包过滤，多个包用英文逗号隔开，2.2.2开始需要采用正则：com.test.controller.*
"md5EncryptedHtmlName": false,//只有每个controller生成一个html文件时才使用
"style":"xt256", //基于highlight.js的代码高设置,可选值很多可查看码云wiki，喜欢配色统一简洁的同学可以不设置
// "projectName": "chapter9",//配置自己的项目名称，不设置则插件自动获取pom中的projectName
"skipTransientField": true,//目前未实现
"sortByTitle":false,//接口标题排序，默认为false,@SInCE 1.8.7版本开始
"showAuthor":true,//是否显示接口作者名称，默认是true,不想显示可关闭
"requestFieldToUnderline":true,//自动将驼峰入参字段在文档中转为下划线格式,//@SInCE 1.8.7版本开始
"responseFieldToUnderline":true,//自动将驼峰入参字段在文档中转为下划线格式,//@SInCE 1.8.7版本开始
"inlineEnum":true,//设置为true会将枚举详情展示到参数表中，默认关闭，//@SInCE 1.8.8版本开始
"recursionLimit":7,//设置允许递归执行的次数用于避免一些对象解析卡主，默认是7，正常为3次以内，//@SInCE 1.8.8版本开始
"allInOneDocFileName":"index.html",//自定义设置输出文档名称, @SInCE 1.9.0
"requestExample":"true",//是否将请求示例展示在文档中，默认true，@SInCE 1.9.0
"responseExample":"true",//是否将响应示例展示在文档中，默认为true，@SInCE 1.9.0
"ignoreRequestParams":[ //忽略请求参数对象，把不想生成文档的参数对象屏蔽掉，@SInCE 1.9.2
"org.springframework.ui.ModelMap"
],
"dataDictionaries": [{ //配置数据字典，没有需求可以不设置
"title": "http状态码字典", //数据字典的名称
// "enumClassName": "org.chapter9.ResponseStatus", //数据字典枚举类名称
"codeField": "responseCode",//数据字典字典码对应的字段名称
"descField": "description"//数据字典对象的描述信息字典
}],
"errorCodeDictionaries": [{ //错误码列表，没有需求可以不设置
"title": "title",
// "enumClassName": "org.chapter9.ResponseStatus", //错误码枚举类
"codeField": "responseCode",//错误码的code码字段名称
"descField": "description"//错误码的描述信息对应的字段名
}],
"revisionLogs": [{ //文档变更记录，非必须
"version": "1.0", //文档版本号
"revisionTime": "2026-05-11 22:12:01", //文档修订时间
"status": "update", //变更操作状态，一般为：创建、更新等
"author": "xiaoyuge", //文档变更作者
"remarks": "init user xiaoyuge" //变更描述
},{ //文档变更记录，非必须
"version": "1.1", //文档版本号
"revisionTime": "2023-05-15 12:12:02", //文档修订时间
"status": "update", //变更操作状态，一般为：创建、更新等
"author": "xiaoyuge", //文档变更作者
"remarks": "add address xiaoyuge" //变更描述
}
],
"customResponseFields": [{ //自定义添加字段和注释，一般用户处理第三方jar包库，非必须
"name": "code",//覆盖响应码字段
"desc": "响应代码",//覆盖响应码的字段注释
"ownerClassName": "org.springframework.data.domain.Pageable", //指定你要添加注释的类名
"ignore":true, //设置true会被自动忽略掉不会出现在文档中
"value": "00000"//设置响应码的值
}],
"requestHeaders": [
{ //设置请求头，没有需求可以不设置
"name": "token",//请求头名称
"type": "string",//请求头类型
"desc": "desc",//请求头描述信息
"value":"token请求头的值",//不设置默认null
"required": false,//是否必须
"since": "-",//什么版本添加的改请求头
"pathPatterns": "/app/test/",//请看https://gitee.com/smart-doc-team/smart-doc/wikis/请求头高级配置?sort_id=4178978
"excludePathPatterns":"/app/page/"//请看https://gitee.com/smart-doc-team/smart-doc/wikis/请求头高级配置?sort_id=4178978
}
],
"requestParams": [ //设置公共参数，没有需求可以不设置
{
"name": "configPathParam",//请求名称
"type": "string",//请求类型
"desc": "desc",//请求描述信息
"paramIn": "path", // 参数所在位置 header-请求头, path-路径参数, query-参数
"value":"testPath",//不设置默认null
"required": false,//是否必须
"since": "2.2.3",//什么版本添加的该请求
"pathPatterns": "/app/test/",//请看https://gitee.com/smart-doc-team/smart-doc/wikis/请求高级配置?sort_id=4178978
"excludePathPatterns":"/app/page/"//请看https://gitee.com/smart-doc-team/smart-doc/wikis/请求高级配置?sort_id=4178978
}],

}

4. smart-doc:markdown
5. When using smart-doc, it is not recommended to use Map to receive parameters, Check it in com.xgry.bpm.api.business.sbf.controller.SbfController#NewPrice
   [ERROR]
   java.lang.RuntimeException: ERROR: #modelClassListConvertTree() - bad @param javadoc from com.xgry.bpm.api.base.tabel.tableclass.controller.TableClassController, This is an invalid comment.

Possible Solution (Bug解决建议，社区已开启国际化推广，请用文心一言、讯飞星火等辅助翻译成英文，减少社区开发者的工作)

No response

Context (Bug影响描述，社区已开启国际化推广，请用文心一言、讯飞星火等辅助翻译成英文，减少社区开发者的工作)

No response

Validations

• Check if you're on the latest smart-doc version. (请检查是否为最新版本)
• Read the docs. (请先阅读官方文档)
• Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. (检查是否存在报告相同错误的问题，以避免产生重复)

[linwumingshi]

@1498610052 Please update to the latest version and try again. If there are still errors, please provide a minimal example code and attach the complete error log.

[1498610052]

I've just integrated the POM and added a JSON configuration file, with the version being 2.7.7. What should I do next?

[linwumingshi]

I've just integrated the POM and added a JSON configuration file, with the version being 2.7.7. What should I do next?

https://smart-doc-group.github.io/guide/getting-started

[shalousun]

@1498610052 java.lang.RuntimeException: ERROR: #modelClassListConvertTree() - bad @param javadoc from com.xgry.bpm.api.base.tabel.tableclass.controller.TableClassController, This is an invalid comment.
This error indicates that the parameter description in the @param Javadoc of the modelClassListConvertTree method in your controller does not match the actual method parameters, for example, the parameter comment is invalid.