博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
【Java】命名规范
阅读量:2490 次
发布时间:2019-05-11

本文共 898 字,大约阅读时间需要 2 分钟。

一、命名规范

    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

 

转载地址:http://fmxrb.baihongyu.com/

你可能感兴趣的文章
int(3)和int(11)区别
查看>>
201521123061 《Java程序设计》第十一周学习总结
查看>>
代码小思考
查看>>
Unity中的销毁方法
查看>>
ceph删除pool提示(you must first set the mon_allow_pool_delete config option to true)解决办法...
查看>>
2016-7-15(1)使用gulp构建一个项目
查看>>
CSS 设计指南(第3版) 初读笔记
查看>>
markdown学习/mou
查看>>
CentOS 搭建 LAMP服务器
查看>>
Android ImageView图片自适应
查看>>
Json串和java对象进行转时
查看>>
Vue提供操作DOM的方法
查看>>
简单正则替换
查看>>
iOS-常用的两个弹簧动画pop
查看>>
Iterable 超级接口
查看>>
第2章 一切都是对象
查看>>
.Net中堆栈和堆的区别
查看>>
BZOJ1085: [SCOI2005]骑士精神
查看>>
配置 tsconfig.json
查看>>
ASP.NET系列:自定义配置节点的复用
查看>>