本文主要是介绍Java——制作工具类说明书(注释),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
步骤:
1、写一个工具类
2、对这个类加入文档注释
A:对类的注释:(在类名上方添加注释)
注释格式:
/**
* 说明类的作用
*@auther 作者
*@version 版本号
*/
B:对类中的方法添加注释:(在方法名上注释)
注释格式:
/**
* 说明方法的作用,如果有输出,标明输出的数据类型和格式
*@param 方法的参数1:参数的作用
*@param 方法的参数2:参数的作用
...
*@param 方法的参数n:参数的作用
*@return 返回值类型:返回一个什么值以及返回值的作用
*/
这篇关于Java——制作工具类说明书(注释)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!