一篇文章让你弄懂Java命名规范的内容
2021-08-18 14:01:34
浏览数 (2473)
前言
在编程的世界里,每种语言都有自己的一些规范。下面,就带你了解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、 所有命名规则必须遵循以下原则;
(1) 名称只能有字母、数字、下划线和$符号组成;
(2) 不能以数字开头;
(3) 名称坚决不能用Java中的关键字;
(4) 坚决不允许出现中文或拼音命名;
二、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 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
即:
到此这篇关于Java规范的文章就介绍到这了,更多相关Java的内容请,搜索W3Cschool以前的文章或继续浏览下面的相关文章,也希望大家以后多多支持!