您的位置:首页 > 编程语言 > Java开发

JAVA知识详细总结Day02之注释

2020-07-16 19:58 96 查看

注释

类注释
在每个类前面必须加上类注释,注释模板如下:

/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date    创建日期
* @version 1.00
*/

属性注释
在每个属性前面须加上属性注释,注释模板如下:

/** 提示信息 */
private String strMsg = null;

**方法注释 **
在每个方法前面须加上方法注释,注释模板如下:

/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:

/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/

方法内部注释

在方法内部使用单行或者多行注释,该注释根据实际情况添加。
如:

//背景颜色
Color bgColor = Color.RED
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签: