jar
maven加载第三方jar 举栗子 没有第三方jar的可以跳过。
com.junit
com.junit
1.0
system
${pom.basedir}/src/main/resources/lib/junit-4.12.jar
注释一定要规范~~~
如图下图 我写的工具类
javadoc居然可以解决jar包中代码注释的问题,那么什么是javadoc呢? 百度百科中的解释是:javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。 javadoc的注解方式是有一定格式的,常用的注解方式有
| 标签 | 说明 | JDK 1.1 doclet | 标准doclet | 标签类型 |
| — | — | — | — | — |
| @author 作者 | 作者标识 | √ | √ | 包、 类、接口 |
| @version 版本号 | 版本号 | √ | √ | 包、 类、接口 |
| @param 参数名 描述 | 方法的入参名及描述信息,如入参有特别要求,可在此注释。 | √ | √ | 构造函数、 方法 |
| @return 描述 | 对函数返回值的注释 | √ | √ | 方法 |
| @deprecated 过期文本 | 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
| @throws异常类名 | 构造函数或方法所会抛出的异常。 | | √ | 构造函数、 方法 |
| @exception 异常类名 | 同@throws。 | √ | √ | 构造函数、 方法 |
| @see 引用 | 查看相关内容,如类、方法、变量等。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
| @since 描述文本 | API在什么程序的什么版本后开发支持。 | √ | √ | 包、类、接口、值域、构
《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》
【docs.qq.com/doc/DSmxTbFJ1cmN1R2dB】 完整内容开源分享
造函数、 方法 |
| {@link包.类#成员 标签} | 链接到某个特定的成员对应的文档中。 | | √ | 包、类、接口、值域、构造函数、 方法 |
| {@value} | 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。 | | √(JDK1.4) | 静态值域 |
此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,由于不常使用,我们不展开叙述,感兴趣的读者可以查看帮助文档。
**注释非常重要,不能随意增加或者修改成其他内容,否则会只是报错,打包不通过。**如果一个类或者方法前增加了注解,且方法中存如param,return 或者throws时,注解中不添加的话也是会抛出警告的。所以注解要加的清晰易懂且符合规范。更多的关于javadoc的注解使用,可以通过参考资料查看其它更丰富的内容。
打包成功后,target会有三个jar包