文档

一个公共的jar包，会被很多项目用到，需要一份简单文档就可以解决很多多沟通的问题。

那么一份合格的文档应该包含如下内容：

1. 一句话描述本模块的功能

2. 如何快速使用

3.常见问题

4. 联系方式

二、最小依赖

如无必要，勿引依赖。若有必要引入，但是并非必须，记得使用provided。

加上provided意味着打包的时候不会将这个依赖加入到 jar 包中，而是需要使用者自己引入

一个小小的设置，带来的好处就是，不会间接地引入其他的依赖了。这在一个大工程中相当重要，当一个项目中的外部依赖多了之后，外部依赖之间如果存在冲突，解决起来将会相当棘手。

三、附上源码

不知道你有没有过这样的经历：引用了一个jar包，准备开始使用的时候，代码提示全是 var1, var2, var3 这种的，点进去一看，傻眼了：

试想一下，这时你的用户在用你的jar包的时候会不会也是这样吐槽。那么怎么解决呢？

其实很简单，只要在pom文件中添加 maven-source-plugin 插件即可。

这样就可以在编译时添加源码包，当发布到maven仓库时，也会自动带上源码。用户在使用 IDEA 的时候也就可以直接下载并关联源码了。因为关联上源码，我们写在上面的注释也可以被使用者看见，这可比文档好用得多哦！