博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
规范的Java项目命名格式
阅读量:4205 次
发布时间:2019-05-26

本文共 807 字,大约阅读时间需要 2 分钟。

【一】项目名

  • 全部小写。如:shop

【二】包名

  • 全部小写。

【三】类名,接口名

  • 首字母大写,多个单词组成,每个单词的首字母大写。如:
public class MyProject{}

【四】方法名

  • 首字母小写,多个单词组成,每个单词的首字母大写。如:
public void myDemo(){}

【五】变量名

(1)普通变量名

  • 同方法的命名,一般为名词。如:int num=12;

(2)常量名(静态变量名)

  • 全部大写,一般为名词。如:public static final String GAME_COLOR=”RED”;

【六】属性文件properties

  • 以下划线隔开。如:errors_zh_CN.properties,hibernate_test.properties

【七】数据库命名

  • 表、字段命名全部大写,多个单词以_隔开

【八】注释规范

8.1、类注释

  • 在每个类前面必须加上类注释,注释模板如下:
/*** Copyright (C), 2006-2010, Anhui Love info. Co., Ltd.* FileName: Test.java* 类的详细说明** @author 类创建者姓名* @Date    创建日期* @version 1.00*/

 8.2、属性注释

  • 在每个属性前面必须加上属性注释,注释模板如下:
/** 提示信息 */private String strMsg = null;

8.3、方法注释

  • 在每个方法前面必须加上方法注释,注释模板如下:
    /*** 构造方法的详细使用说明** @param 参数1 参数1的使用说明* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明*/

8.5、方法内部注释

  • 在方法内部使用单行或者多行注释,该注释根据实际情况添加。如:
//背景颜色Color bgColor = Color.RED

原文地址:

转载地址:http://urxli.baihongyu.com/

你可能感兴趣的文章
《MySQL必知必会》——笔记
查看>>
《Spring揭秘》——AOP(笔记)
查看>>
《TCP/IP详解卷3》——HTTP(笔记)
查看>>
JVM——main()方法的执行。
查看>>
观止——《从Decorator,Adapter模式看Java/IO库》
查看>>
《Erlang程序设计》——笔记
查看>>
Erlang开发环境Windows+Emacs+Distel配置
查看>>
Erlang的特点——小结
查看>>
Erlang的makefile——小例子
查看>>
蜗牛爬井——Erlang版本
查看>>
《Erlang程序设计》第8章习题解
查看>>
Erlang学习资料
查看>>
Erlang中的xml的转换
查看>>
一些Erlang的图形界面工具
查看>>
java-阻塞队列
查看>>
spring-cloud-eureka
查看>>
springcloud采坑-jason序列化中的Date对象
查看>>
JDK-SPI简介【一】
查看>>
spring cloud采坑列表
查看>>
mochiweb——初始化
查看>>