Java项目命名规范

我不是女神ヾ 2022-01-13 04:13 237阅读 0赞

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][]

一、命名规范

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][version] 1.00

\*/

2、 属性注释

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

/\*\* 提示信息 \*/

private String strMsg = null;

3、 方法注释

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

/\*\*

\* 类方法的详细使用说明

\*

\* @param 参数1 参数1的使用说明

\* @return 返回结果的说明

\* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

\*/

4、 构造方法注释

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

/\*\*

\* 构造方法的详细使用说明

\*

\* @param 参数1 参数1的使用说明

\* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

\*/

5、 方法内部注释

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

如：//背景颜色

Color bgColor = Color.RED

转载于:https://my.oschina.net/zhanghaiyang/blog/594858

[2019_Python_]: https://my.oschina.net/u/2663968/blog/3061697
[hot3.png]: /images/20220113/9ef9d223289340cb9817e34fad52983e.png
[version]: http://my.oschina.net/u/931210

发表评论取消回复

表情：

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

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

相关阅读

相关 Java命名规范

Java命名规范一、一般概念 1、尽量使用完整的英文描述符 2、采用适用于相关领域的术语 3、采用大小写混合使名字可读 4、尽量少用缩写，但

末蓝、/ 2024年02月18日 16:54/ 0 赞/ 3 阅读

相关 Java命名规范

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

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

相关 Java项目命名规范

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 一、命名规范 1、项目名全部小写 2、包名全部小

拼搏现实的明天。/ 2022年10月02日 08:52/ 0 赞/ 133 阅读

相关项目版本命名规范

版本命名格式 GNU 风格、Windows 风格主版本号 . 子版本号 \[. 修正版本号 \[. 编译版本号 \]\] Major.Minor\[.Revi

梦里梦外;/ 2022年08月08日 12:49/ 0 赞/ 307 阅读

相关 java命名规范

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

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

相关 java项目命名规范

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

深藏阁楼爱情的钟/ 2022年06月02日 09:52/ 0 赞/ 211 阅读

相关 Java项目命名规范

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 一、命名规范 1、项目名全部小写 2、包名全部小

我不是女神ヾ/ 2022年01月13日 04:13/ 0 赞/ 238 阅读

相关 JAVA命名规范

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

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

相关 java项目中包的命名规范

一、包命名规范为什么把包命名单独提出来呢？因为之前的命名一直是有问题的，被别人质疑了，所以这里单独提出来记录一下。问题是关于包名里的下划线（\_）是使用，如果包名的一

傷城~/ 2021年09月23日 09:32/ 0 赞/ 775 阅读

相关规范的Java项目命名格式

【一】项目名全部小写。如：shop 【二】包名全部小写。【三】类名，接口名首字母大写，多个单词组成，每个单词的首字母大写。如： p

港控/mmm°/ 2021年09月16日 15:36/ 0 赞/ 301 阅读