文档章节

Java项目命名规范

a
 ahucsxl
发布于 2016/04/10 19:21
字数 476
阅读 23
收藏 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

共有 人打赏支持
a
粉丝 1
博文 82
码字总数 39098
作品 0
合肥
【XML系列】详解JDOM解析XML

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

磊神Ray
2011/11/01
0
0
ZooKeeper学习笔记八 ZooKeeper典型应用场景——命名服务

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

xundh
05/02
0
0
【J2EE系列】JNDI与tomcat连接池

JNDI与tomcat连接池 本章内容 ² JNDI与JNDI服务器 ² 编码实现JNDI目录服务与命名服务 ² 使用Tomcate JNDI服务器 一、JNDI概述 1、什么是JNDI? 英文全称是:Java Naming and Directory Inte...

磊神Ray
2012/02/15
0
1
学会这几点,你会成为一名月薪过万的Java程序员

每一个稍微有点出息的人,都应该把行业里的前三名作为自己奋斗的目标和对手。你离成为冠军Java程序员还有多远,看完这篇你就知道了。 软件工程师的职业生涯里,知识有一个三年的半衰期。这意...

梦想远方_8e96
06/12
0
0
转一个J2EE开发时的包命名规则,养成良好的开发习惯

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

绝艳天纵
2012/04/12
0
0

没有更多内容

加载失败,请刷新页面

加载更多

RxJS的另外四种实现方式(四)——性能最高的库(续)

接上一篇RxJS的另外四种实现方式(三)——性能最高的库 上一篇文章我展示了这个最高性能库的实现方法。下面我介绍一下这个性能提升的秘密。 首先,为了弄清楚Most库究竟为何如此快,我必须借...

一个灰
今天
1
0
麒麟AI首席科学家现世

8月31日,华为发布了新一代顶级人工智能手机芯片麒麟980,成为全球首款7nm工艺手机芯片,AI方面也实现飞跃,支持人脸识别、物体识别、物体检测、图像分割、智能翻译等。 虽然如今人人都在热议...

问题终结者
昨天
1
0
告警系统主脚本、告警系统配置文件、告警系统监控项目

告警系统主脚本 main.sh内容 #!/bin/bash#Written by aming.# 是否发送邮件的开关export send=1# 过滤ip地址export addr=`/sbin/ifconfig |grep -A1 "ens33: "|awk '/inet/ {pr...

芬野de博客
昨天
2
0
MySQL autocommit探究

-- sessionA:tx_isolation=REPEATABLE-READmysql> select connection_id();+-----------------+| connection_id() |+-----------------+| 28 |+-----------------+......

安小乐
昨天
8
0
c++多线程锁 Mutex  自动判断死锁

c++多线程锁可以使用absl::Mutex std::mutex这两种,下面是demo代码。 使用absl:Mutex的时候打印: [mutex.cc : 1338] RAW: Cycle: [mutex.cc : 1352] RAW: mutex@0x683b68 stack: @ 0x43856......

青黑
昨天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部