文档章节

Java项目命名规范

a
 ahucsxl
发布于 2016/04/10 19:21
字数 476
阅读 22
收藏 3
点赞 1
评论 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


本文转载自: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
MyBatis笔记(一)——带你入门带你飞

MyBatis(原名是ibatis)简介 MyBatis是支持普通SQL查询,存储过程和高级映射的优秀持久层框架。MyBatis消除了几乎所有的JDBC代码和参数的手工设置以及对结果集的检索封装。MyBatis可以使用简单...

HappyBKs
2015/07/02
0
5
0基础学Java Java开发学习需要什么工具?

JDK是Java开发工具包 (Java Development Kit) 的缩写。它是一种用于构建在Java平台上发布的应用程序、applet 和组件的开发环境。其中包括了Java编译器、JVM、大量的Java工具以及Java基础API...

老男孩Linux培训
07/12
0
0
Apache commons (Java常用工具包)简介

Apache Commons是一个非常有用的工具包,解决各种实际的通用问题,下面是一个简述表,详细信息访问http://jakarta.apache.org/commons/index.html BeanUtils Commons-BeanUtils 提供对 Java...

Coder小兵
2012/02/04
0
0
J2EE中一些常用的名词【简】

web容器:给处于其中的应用程序组件(JSP,SERVLET)提供一个环境,使JSP,SERVLET直接更容器中的环境变量接口交互,不必关注其它系统问题。主要有WEB服务器来实现。例如:TOMCAT,WEBLOGIC,W...

anlve
06/18
0
0
Gradle学习之构建java与web项目

一.使用Gradle的java插件构建Java项目 1)Gradle插件包含了若干个接口定义和已有的任务项,语法结构:apply plugin:'插件名' ,此处我们定义插件 apply plugin : 'java' 2)Gradle希望我们的j...

java~nick
01/12
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

4 个快速的 Python 编译器 for 2018

简评:Python 和其他的解释型语言一样经常被吐槽性能不行,所以开发人员为了提升性能创建了不少编译器,本文则选取其中的四个做了基准测试。 Python 其实是一种相当快的语言,但它并不像编译...

极光推送
5分钟前
0
0
SSO CAS单点登录搭建详细步骤及源码

1.因为是本地模拟sso环境,而sso的环境测试需要域名,所以需要虚拟几个域名出来,步骤如下: 2.进入目录C:\Windows\System32\drivers\etc 3.修改hosts文件 127.0.0.1 jeesz.cn 127.0.0.1 sso...

明理萝
6分钟前
0
1
spring boot注册多个MQ服务器的问题

关于注册到多个MQ源的文章已经有很多了,这里记录一下声明queue的坑; 如果使用注册bean的方式声明queue,会导致声明的queue同时被注册到所有的MQ源上; //如果使用下面的声明方式,que...

placeholder
6分钟前
0
0
Java面试基础篇——第九篇:BIO,NIO,AIO的区别

现在IO模型主要分三类:BIO(同步阻塞IO),NIO(同步非阻塞IO),AIO()。 先来看看BIO。 1. BIO 服务端接受到请求后,要指派或新建一个线程去处理客户端的IO请求,直到收到断开连接的指令。这么做...

developlee的潇洒人生
11分钟前
0
0
@RequestMapping @ResponseBody 和 @RequestBody 用法与区别

1.@RequestMapping 国际惯例先介绍什么是@RequestMapping,@RequestMapping 是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为...

特拉仔
14分钟前
1
0
基于 HTML5 结合互联网+ 的 3D 隧道

前言 目前,物资采购和人力成本是隧道业发展的两大瓶颈。比如依靠民间借贷,融资成本很高;采购价格不透明,没有增值税发票;还有项目管控和供应链管理的问题。成本在不断上升,利润在不断下...

xhload3d
16分钟前
0
0
济南小程序热度分析

原文链接:http://www.jnqianle.cn/company/2072.html

tianma3798
16分钟前
1
0
大数据软件

beats 采集 kafka spark hive es grafana zeppelin

ArlenXu
19分钟前
0
0
Mac item2常用快捷键

标签 新建标签:command + t 关闭标签:command + w 切换标签:command + 数字 command + 左右方向键 切换全屏:command + enter 查找:command + f 分屏 水平分屏:command + d 垂直分屏:c...

说回答
22分钟前
0
0
mac常用软件

1.excel for mac http://www.pc6.com/mac/114205.html

小黑202
22分钟前
0
0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部