文档章节

Java项目命名规范

a
 ahucsxl
发布于 2016/04/10 19:21
字数 476
阅读 24
收藏 3

一、命名规范


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


本文转载自:http://www.cnblogs.com/maowang1991/archive/2013/06/29/3162366.html

共有 人打赏支持
上一篇: Git 学习
下一篇: Fragments
a
粉丝 1
博文 82
码字总数 39098
作品 0
合肥
私信 提问
跟我学习dubbo-在Linux操作系统上手工部署Dubbo服务(5)

在Linux操作系统上手工部署Dubbo服务 1、环境变量配置 Java环境变量----只需要JRE vi /etc/profile ## java env export JAVA_HOME=/usr/local/java/jdk1.7.0_72 export JRE_HOME=$JAVA_HOME......

HI曲奇饼干
2016/01/09
153
1
Java EE 成为过去,Eclipse 为其“改名”望成为顶级开源项目!

Eclipse 基金会开放源代码项目主管 Wayne Beaton在GitHub 上提出了一个问题,他表示,Java EE 需要一个新的名称。该品牌也将成为兼容,独立实施行业的认证标志,这个名字将让 Eclipse EE4J 顶...

周其
2017/11/18
4.4K
12
【XML系列】详解JDOM解析XML

【XML系列】详解JDOM解析XML 一、前言 JDOM是Breet Mclaughlin和Jason Hunter两大Java高手的创作成果,2000年初,JDOM作为一个开放源代码项目正式开始研发。JDOM是一种解析XML的Java工具包。...

磊神Ray
2011/11/01
0
0
转一个J2EE开发时的包命名规则,养成良好的开发习惯

代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。 代码编写规范使用范围:J2EE项目开发。 包命名规范: 目的:包的命名规范应当体现出项目资源良好的...

绝艳天纵
2012/04/12
0
0
ZooKeeper学习笔记八 ZooKeeper典型应用场景——命名服务

《从Paxos到ZooKeeper分布式一致性原理与实践》 电子工业出版社 命名服务是分布式系统中比较常见的一类场景。命名服务是分布式系统最基本的公共服务之一。在分布式系统中,被命名的实体通常可...

xundh
2018/05/02
0
0

没有更多内容

加载失败,请刷新页面

加载更多

string类回顾

writeademo
8分钟前
0
0
在DataWorks中实现指定UDF只能被指定账户访问

在DataWorks中实现指定资源被指定账户访问 背景 之前写过一篇文章是关于“DataWorks和MaxCompute内部权限体系的区别”有兴趣的朋友可以点击阅读查看详情。但是还是有些同学会问,我如何在Dat...

阿里云云栖社区
9分钟前
0
0
MaxCompute安全管理指南-案例篇

通过《MaxCompute安全管理-基础篇》了解到MaxCompute和DataWorks的相关安全模型、两个产品安全方面的关联,以及各种安全操作后,本篇主要给出一些安全管理案例,给安全管理的成员作为参考。 ...

阿里云官方博客
13分钟前
0
0
Spring Cloud 中使用Feign解决参数注解无法继承的问题

Spring Cloud 中使用Feign解决参数注解无法继承的问题 在使用Feign的时候,通常先写一个接口类,然后再写实现类,根据官网的例子接下来编写一个简单的Feign的请求例子 @FeignClient("spring...

不学无数的程序员
14分钟前
0
0
springboot kafka读写

依赖 <dependency> <groupId>org.springframework.kafka</groupId> <artifactId>spring-kafka</artifactId> <version>1.1.1.RELEASE</version></dependency> 配置 #=======......

张欢19933
20分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部