Java开发，普遍的命名规范。供参考。

￡神魔★判官ぃ 2022-05-14 07:07 224阅读 0赞

**一、命名规范**

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

发表评论取消回复

表情：

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

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

相关阅读

相关 Java开发中的命名规范问题探讨

在Java开发中，命名规范是非常重要的一部分，它直接影响代码的可读性、一致性以及后期维护的便利性。以下是一些常见的命名规范： 1. **驼峰命名**：类名、接口名和方法名使用

我就是我/ 2024年12月01日 05:24/ 0 赞/ 29 阅读

相关代码规范：Java开发中常见的命名规范问题

在Java开发中，命名规范是非常重要的一部分，它可以帮助开发者理解代码的作用和关系。以下是一些常见的命名规范问题： 1. 类名： - 避免使用Java关键字作为类名，如

小鱼儿/ 2024年11月26日 08:45/ 0 赞/ 35 阅读

相关 java命名规范(Java命名规范是不必要的吗)

简述java中变量的命名规则？ ![java命名规范][java] 使用Java作为程序语言时，好的命名规范有哪些 Package 的命名 Package 的名

Myth丶恋晨/ 2023年09月25日 08:26/ 0 赞/ 90 阅读

相关 Java开发都需要参考的一份命名规范（强推！）

刚发一份在网课上学的Java命名规则，就发现了一份超详细的命名规范，大佬还是大佬啊，请收下我的膝盖。因此作为我在CSDN的第一次转载就给它了。本来想一直自己写的。 -----

Love The Way You Lie/ 2023年07月22日 03:58/ 0 赞/ 11 阅读

相关 Java命名规范参考

Java命名规范参考一、Java中的命名规范二、包命名三、类命名四、方法 4.1 返回真伪值的方法 4.2 用来

女爷i/ 2022年10月12日 15:54/ 0 赞/ 354 阅读

相关前端开发规范参考

前言：前端开发规范参考分享前端开发规范参考一、规范目的二、通用规范三、框架开发规范 1、项目使用框架 2、学习资料

秒速五厘米/ 2022年09月13日 04:14/ 0 赞/ 382 阅读

相关 Java工程开发命名规范

1.包：java的包名都是由小写单词组成的，类名的首字母都是大写，也就是我们常用的驼峰写法，包路径一般都是对系统模板的定义与归类。这样看了包名很容易就明白哪一个模块是干什么的，

系统管理员/ 2022年08月23日 00:42/ 0 赞/ 260 阅读

相关 Python开发命名规范

引言软件开发中规范的命名能够使你的代码简洁美观，完美的命名规范是一个程序员最基本的技能。下面我先简单说说两种常用的命名方式：驼峰命名法混合使用大小写字母来构成变

傷城~/ 2022年05月21日 07:11/ 0 赞/ 284 阅读

相关 Java开发，普遍的命名规范。供参考。

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

￡神魔★判官ぃ/ 2022年05月14日 07:07/ 0 赞/ 225 阅读

相关前端开发命名规范

https://blog.51cto.com/13507333/2052369 变量名：字母数字下划线和$符号组成，不能由数字开头；不能和系统关键词重名转载于:https

末蓝、/ 2021年12月24日 07:03/ 0 赞/ 393 阅读