首页 >Java >Java入门 >java命名规范、命名格式介绍

java命名规范、命名格式介绍

王林
王林转载
2020-11-18 15:17:513165浏览

java命名规范、命名格式介绍

准确的编码格式与规范对编程工作者是非常重要的,下面为大家分享一下java中的命名规范与命名格式。

一、命名规范

(学习视频分享:java教学视频

1、 项目名全部小写

2、 包名全部小写

3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。

如:

public class MyFirstClass{}

4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。

如:

int index=0;
public void toString(){}

5、 常量名全部大写

如:

public static final String GAME_COLOR=”RED”;

6、所有命名规则必须遵循以下规则:

  • 名称只能由字母、数字、下划线、$符号组成

  • 不能以数字开头

  • 名称不能使用JAVA中的关键字。

  • 坚决不允许出现中文及拼音命名。

二、注释规范

1、 类注释

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

/**
Copyright ©, 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入门教程

以上是java命名规范、命名格式介绍的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文转载于:csdn.net。如有侵权,请联系admin@php.cn删除