1.环境
jdk1.8,maven 3.2.5
2.maven配置
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<executions>
<execution>
<goals>
<goal>javadoc</goal>
</goals>
<phase>process-classes</phase>
<configuration>
<encoding>UTF-8</encoding>
<charset>UTF-8</charset>
<doclet>com.github.uhfun.swagger.doclet.SwaggerMoreDoclet</doclet>
<docletArtifacts>
<docletArtifact>
<groupId>com.github.uhfun</groupId>
<artifactId>swagger-more-javadoc</artifactId>
<version>1.0.2-SNAPSHOT</version>
</docletArtifact>
<docletArtifact>
<groupId>com.xy</groupId>
<artifactId>xyPostalWork-api</artifactId>
<version>0.0.1-SNAPSHOT</version>
</docletArtifact>
</docletArtifacts>
<additionalOptions>
<additionalOption>-classDir ${project.build.outputDirectory}
</additionalOption>
</additionalOptions>
<sourcepath>${project.build.sourceDirectory}</sourcepath>
<subpackages>com.xy.service</subpackages>
<useStandardDocletOptions>false</useStandardDocletOptions>
</configuration>
</execution>
</executions>
</plugin>
3.打包时报错信息:
Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.1.1:javadoc (default) on project xyPostalWork-api: An error has occurred in Javadoc report generation:
Exit code: 1 - E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IUnionAreaService.java:23: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IUnionAreaService.java:30: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IUnionAreaService.java:36: ���� - @return ���û�в�����
javadoc: ���� - No javadoc found in class com.xy.service.ISkuSpecs.ISkuSpecs
javadoc: ���� - No javadoc found in class com.xy.service.ISkuAttrValue.ISkuAttrValue
javadoc: ���� - The number of comment parameters for method [com.xy.service.IShopService.addNew(String, String, String, String, String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IShopService.addNew(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IShopService.getShopList(String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IShopService.getShopList(java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IPrinterService.getShopPrinterList(String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IPrinterService.getShopPrinterList(java.lang.String)
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IPrinterService.java:26: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IPrinterService.java:33: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IPrinterService.java:40: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IPrinterService.java:47: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IPrinterService.java:54: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IPrinterService.java:64: ���� - @return ���û�в�����
javadoc: ���� - The number of comment parameters for method [com.xy.service.IPrinterService.printOrderInfo(String, String, String, String)] in javadoc is incorrect
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IPrinterProductService.java:16: ���� - @return ���û�в�����
javadoc: ���� - The number of comment parameters for method [com.xy.service.IPrinterFailedService.addPrinterFailed(String, String, int, String, String)] in javadoc is incorrect
javadoc: ���� - The number of comment parameters for method [com.xy.service.IPrinterFailedService.checkExist(String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IPrinterFailedService.checkExist(java.lang.String)
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:28: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:42: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:49: ���� - @return ���û�в�����
javadoc: ���� - The number of comment parameters for method [com.xy.service.IOrderService.getCustomerOrder(String, Integer, Integer)] in javadoc is incorrect
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:58: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:67: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:74: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:81: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:88: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderService.java:95: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderDetailService.java:23: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderDetailService.java:30: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderDetailService.java:37: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderDetailService.java:44: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IOrderDetailService.java:51: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IMenuService.java:26: ���� - @return ���û�в�����
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IMenuService.java:35: ���� - @return ���û�в�����
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsTypeService.getGoodsTypeList(String, Long, Long, String, String, String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsTypeService.getGoodsTypeList(java.lang.String, java.lang.Long, java.lang.Long, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsTypeService.addFoodGoodType(GoodsType)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsTypeService.addFoodGoodType(com.xy.pojo.GoodsType)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsTypeService.typeNameExist(String, String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsTypeService.typeNameExist(java.lang.String, java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsTypeService.updateGoodType(GoodsType)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsTypeService.updateGoodType(com.xy.pojo.GoodsType)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsTypeService.deleteById(String, String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsTypeService.deleteById(java.lang.String, java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsTypeService.getTypeList(String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsTypeService.getTypeList(java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsService.deleteFood(String, String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsService.deleteFood(java.lang.String, java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsService.getFoodList(Double, Cusinf)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsService.getFoodList(java.lang.Double, com.xy.pojo.Cusinf)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsService.updateGoods(Cusinf, FoodsVo)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsService.updateGoods(com.xy.pojo.Cusinf, com.xy.vo.FoodsVo.FoodsVo)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsService.goodsName(Cusinf, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsService.goodsName(com.xy.pojo.Cusinf, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IGoodsService.goodsName(Cusinf, String, Long)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IGoodsService.goodsName(com.xy.pojo.Cusinf, java.lang.String, java.lang.Long)
E:\xyDiningWork\xyPostalWork-api\src\main\java\com\xy\service\IGoodsService.java:44: ���� - @return ���û�в�����
javadoc: ���� - The number of comment parameters for method [com.xy.service.IDiningTableService.addTable(Cusinf, DiningTable)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IDiningTableService.addTable(com.xy.pojo.Cusinf, com.xy.pojo.DiningTable)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IDiningTableService.existName(String, String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IDiningTableService.existName(java.lang.String, java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IDiningTableService.getList(Cusinf)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IDiningTableService.getList(com.xy.pojo.Cusinf)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IDiningTableService.deleteTable(String, String)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IDiningTableService.deleteTable(java.lang.String, java.lang.String)
javadoc: ���� - The number of comment parameters for method [com.xy.service.IDiningTableService.tableList(ReadOption, DinningTableCondition)] in javadoc is incorrect
javadoc: ���� - No javadoc found in method com.xy.service.IDiningTableService.tableList(com.xy.vo.ReadOption, com.xy.pojo.condition.DinningTableCondition)
javadoc: ���� - Unable to find the corresponding method based on methodDoc export(java.lang.String[], java.lang.String)
com.github.uhfun.swagger.doclet.SwaggerMoreDoclet.matchingMethod(SwaggerMoreDoclet.java:254)
com.github.uhfun.swagger.doclet.SwaggerMoreDoclet.parseAndAnnotate(SwaggerMoreDoclet.java:103)
com.github.uhfun.swagger.doclet.SwaggerMoreDoclet.start(SwaggerMoreDoclet.java:76)
sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
java.lang.reflect.Method.invoke(Method.java:498)
com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:310)
com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:189)
com.sun.tools.javadoc.Start.parseAndExecute(Start.java:366)
com.sun.tools.javadoc.Start.begin(Start.java:219)
com.sun.tools.javadoc.Start.begin(Start.java:205)
com.sun.tools.javadoc.Main.execute(Main.java:64)
com.sun.tools.javadoc.Main.main(Main.java:54)
Command line was: D:\jdk1.8\jre..\bin\javadoc.exe @options
Refer to the generated Javadoc files in 'E:\xyDiningWork\xyPostalWork-api\target\site\apidocs' dir.