java的命名规范与注释规范

偏执的太偏执、 2021-09-27 04:20 340阅读 0赞

# 一、java命名规范 #

1、项目名全部小写

2、包名全部小写

3、类名首字母大写，若类名由多个单词构成，每个单词首字母大写，即大驼峰命名

public class HelloWorld(){ }

4、变量名、方法名首字母小写，若其由多个单词构成，每个单词首字母大写，即小驼峰命名法

public void sayHello(){ }
    
    String userName ="luis";

5、常量名全部大写

public static final String ATHOR="luis";

6、以上所有命名遵循规则：

*  名称只能由数字、字母、下划线、$符组成
 *  不能以数字开头
 *  不能是有Java的关键字和保留字
 *  严禁使用汉字和拼音

# 二、java注释规范 #

注释分为文档注释(/\*\* \*/ )、行注释(//) 、块注释(/\* \*/ )三种。

其中文档注释可用来注释类、接口、静态方法、成员方法、静态变量、成员变量、常量

块注释可用来注释文件头、算法实现、方法中的复杂代码块、修改记录

行注释一般用来注释局部变量

下面将对常用的四种注释进行展示：

1、类注释

在每个类前面加上类注释，注释内容包括类或接口名，类和接口功能描述，作者，创建日期，所属公司、版本等：

/**
    * @description：测试类
    * @ClassName：HelloWorld.java
    * @author luis
    * @Date   2018-7-16 18:10:31
    * @version 1.00
    */

2、属性注释

在每个属性前面必须加上属性注释，注释如下:

/** 字符串信息 */
    private String strMsg = null;

3、方法注释

在每个方法前面必须加上方法注释，注释如下：

/**
    * 类方法的详细使用说明
    * @param 参数1 参数1的使用说明
    * @param 参数2 参数1的使用说明
    * @return 返回结果的说明
    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
    */

4、 构造方法注释

在每个构造方法前面必须加上注释，注释如下：

/**
    * 构造方法的详细使用说明
    * @param 参数1 参数1的使用说明
    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
    */

5、 方法内部注释

在方法内部使用单行或者多行注释，该注释根据实际情况添加。

//背景颜色
    Color bgColor = Color.RED

以上为企业在java开发过程中需遵守的命名规范与注释规范，希望能够对开始java学习的我们有所帮助。

发表评论取消回复

表情：

评论列表（有 0 条评论，340人围观）

还没有评论，来说两句吧...

相关阅读

相关 Java命名规范

驼峰命名法应用概述：骆驼式命名法就是当变量名或函数名是由一个或多个单词连结在一起，而构成的唯一识别字时，第一个单词以小写字母开始；从第二个字母开始以后的每个单词的首字母

约定不等于承诺〃/ 2022年12月10日 08:55/ 0 赞/ 158 阅读

相关 java注释规范

以下转自java注释 [http://blog.csdn.net/shiyuezhong/article/details/8205281/][http_blog.csdn.

超、凢脫俗/ 2022年09月23日 08:11/ 0 赞/ 183 阅读

相关 java命名规范

一、命名规范 1、项目名全部小写 2、包名全部小写 3、类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写，即使用驼峰命名法。 4、变量名、方

向右看齐/ 2022年06月05日 12:49/ 0 赞/ 188 阅读

相关编码规范(一)----JAVA注释规范

一、前言好的代码规范是一个程序员的基本修炼，好的代码注释更能体现一个程序员的思维逻辑，虽然代码是用来给机器运行的，我们只要能写出能让编译器运行的代码就行了，但是如

浅浅的花香味﹌/ 2022年06月03日 03:47/ 0 赞/ 295 阅读

相关 JAVA注释和变量命名规范

Java注释单行注释：//内容多行注释：/\ 内容 \/ 文档注释：/\\ 内容 \/ 命名驼峰命名法小驼峰：用于方法名，普通变量名称若标识符是

缺乏、安全感/ 2022年04月18日 03:17/ 0 赞/ 212 阅读

相关 JAVA命名规范

一、命名规范 1、项目名全部小写 2、包名全部小写 3、类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。如：public class MyFi

小灰灰/ 2021年12月17日 04:59/ 0 赞/ 301 阅读

相关命名规范

不能用什么命名？ 1：不能中文命名 2：不能中英混合 3: 不能直接使用css属性明敏 4：不能单独切直接使用html命名命名规则- 驼峰式命名:

￡神魔★判官ぃ/ 2021年11月02日 07:06/ 0 赞/ 402 阅读

相关 java的命名规范与注释规范

一、java命名规范 1、项目名全部小写 2、包名全部小写 3、类名首字母大写，若类名由多个单词构成，每个单词首字母大写，即大驼峰命名 public cla

偏执的太偏执、/ 2021年09月27日 04:20/ 0 赞/ 341 阅读

相关 Java 语法规定之外的命名注释规范

Java 语法规定之外的命名注释规范命名规范 1. 项目名 2. 包名 3. 类名 4. 常量名

悠悠/ 2021年09月25日 00:54/ 0 赞/ 316 阅读

相关 Java 标识符与命名规范

Java 标识符与命名规范 Java标识符 Java命名规范 Java标识符 ![在这里插入图片描述][watermark_type_ZmFuZ3po

╰半橙微兮°/ 2021年09月21日 08:56/ 0 赞/ 332 阅读