javadoc

作为一个开发，不光要多看文档，为了养成更好的变成习惯，我们也要多写文档，所以和大家分享一下javadoc，一个很简单但是又不一定都用的东西

javadoc.exe在java的bin目录中

如何使用javadoc，首先在编写注释代码上要养成良好的习惯，写完整注释，如图

之后执行project生成javadoc的操作

在选定目录中，可以查看到生成的javadoc的文档，内容如下

javadoc为我们提供了如下方法

@author 
对类的说明，标明开发该类模块的作者


@version 
对类的说明，标明该类模块的版本


@see 
对类、属性、方法的说明，描述相关主题


@param 
对方法的说明，对方法中某参数的说明


@return 
对方法的说明，对方法返回值的说明


@throws 
对方法的说明，对方法可能抛出的异常进行说明

编写规范的注释经常被大家忽略，这恰恰也是需要大家注意的，为了更好的coding习惯，重视javadoc~