JAVA命名、注释规范
一、命名规范
1、 项目名全部小写
2、 包名全部小写(除非部分是缩写)
3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
如:public class MyFirstClass{}
4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。即:驼峰法则。
如:int index=0;
public void toString(){}
5、 常量名全部大写
如:public static final String GAME_COLOR=”RED”;
6、所有命名规则必须遵循以下规则:
1)、名称只能由字母、数字、下划线、$符号组成
2)、不能以数字开头
3)、名称不能使用JAVA中的关键字。
4)、坚决不允许出现中文及拼音命名。
二、注释规范
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
最新文章
- Android Butterknife 8.4.0 使用方法总结
- SVN部署和使用
- Mysql 5.7 Linux安装详细步骤
- Linux修改SSH端口,并禁止Root远程登陆
- 委托--delegate
- Hadoop学习笔记2---配置详解
- 【gradle报错】error: package org.apache.http does not exist
- BZOJ2213: [Poi2011]Difference
- Html与css基础
- Oracle SQL函数之转换函数To_char汇总
- SQLServer中使用扩展事件获取Session级别的等待信息以及SQLServer 2016中Session级别等待信息的增强
- uva10410 栈
- python selenum 爬取淘宝
- 2018-2019-2 《网络对抗技术》Exp3 免杀原理与实践 20165215
- 七月在线爬虫班学习笔记(二)——Python基本语法及面向对象
- 设置Firefox(火狐)浏览器的中文菜单/界面
- 基于 LWIP 建立 TCP Server 与主机通信实验
- Intellij Idea 教程
- python第二天 列表、元组
- [转] SSO单点登录原理和流程分析