码迷,mamicode.com
首页 > 编程语言 > 详细

Java ——注释 命名

时间:2019-05-08 16:12:39      阅读:143      评论:0      收藏:0      [点我收藏+]

标签:抛出异常   file   java   nal   背景   null   version   bsp   strong   

注释
1、类
在每个类前面必须加上类注释,注释模板如下:
/**
* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.
* FileName: Test.java
* 类的详细说明
*
* @author 类创建者姓名
* @Date    创建日期
* @version 1.00
*/
 

2、属性
在每个属性前面必须加上属性注释,注释模板如下:
/** 提示信息 */
private String strMsg = null;
 

3、方法
在每个方法前面必须加上方法注释,注释模板如下:
/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
 
4、构造方法
在每个构造方法前面必须加上注释,注释模板如下:
/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
 

5、方法内部
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
如:
//背景颜色
Color bgColor = Color.RED
 
 

Java命名

包名: 由全部小写-------------------com.runoob
 
类和接口:大写开头其他小写-------Person,RuntimeException
 
类变量: 小写开头后面大写-----------currentImage
 
类方法的: 小写开头后面大写----------getBalance()
 
staticfinal变量: 大写-----------------PASSWORD
 
参数: 参数的名字和变量的命名规范一致
 
数组: byte[] buffer

Java ——注释 命名

标签:抛出异常   file   java   nal   背景   null   version   bsp   strong   

原文地址:https://www.cnblogs.com/expedition/p/10832306.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!