文档章节

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
合肥
私信 提问
【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
C#语言————第一章 第一个C#程序

第一章 第一个C#程序 C#程序* ①:建立项目:文件-->新建-->项目-->c#-->控制台程序(项目名/文件存储位置)-->确定 ①:c#程序 namespace:命名空间; 相当于java中的package(声明包) using...

九之者
11/11
0
0
IntelliJ IDEA个人配置

# 主题 # 字体 推荐DejaVu Sans Mono,这个字体绝对爽翻 第二推荐Courier 或者 Courier New # 常用插件 Alibaba Java Coding Guidelines 阿里巴巴编程规范,可以检查自己的java命名规范编程规...

FutaoSmile丶
10/19
0
0

没有更多内容

加载失败,请刷新页面

加载更多

day152-2018-11-19-英语流利阅读-待学习

外媒看吴亦凡刷榜事件 Lala 2018-11-19 1.今日导读 近日,吴亦凡的专辑在国外陷入了刷榜风波,他的新专辑霸占了单曲榜前三名,并且前十名他占据了七席,力压美国乐坛巨星 Lady Gaga 和 A 妹,...

飞鱼说编程
41分钟前
9
0
开源 java CMS - FreeCMS2.8 微信管理 群发图文消息

项目地址:http://www.freeteam.cn/ 群发图文消息 管理员可以在这里群发图文消息 此列表只提取已审核并且带信息图片的数据! 选择需要群发的消息,点击“群发图文消息”按钮。 微信的限定: ...

freeteam
50分钟前
1
0
Beautiful Soup

定义 Python中的一个库,主要用于从网页爬取数据; 安装 pip install beautifulsoup4 四大对象 Beautiful Soup将复杂的HTML文档转换成树形结构,树中的每个节点都是Python对象,对象可归纳为...

村雨1943
今天
5
0
Visual Studio 昨日发布新版本:增加实时同步编程、共同调试

多名开发者可以在同一个项目中编程,在编写代码和调试代码时只需发送一个 URL 网址,就能邀请他人参与协作,而且无需重新配置开发环境和安装任何附加包。该服务支持 Windows、Mac 与 Linux ...

linuxCool
今天
8
0
发现一种不错的学习方法

这是在《软技能,代码之外的生存之道》所看到的一种学习方法,感觉这个理念不错,分享出来,共勉。 我的「十步学习法」 多年以来,我都承受着巨大的压力:快速学习新技术、新编程语言、新框架...

firepation
今天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部