代码改变世界

Java的命名规范

2019-02-01 12:07  橙橙Coder  阅读(203)  评论(0)    收藏  举报

A. javase 中的命名规则
1. 包名: 全小写
2. 类名: pascal
eg.StudentInfo 单词的首字母都大写
3.属性,方法,局部变量 : camel
eg.stuName 从第二个单词起,每个单词首字母大写
4.常量:全大写,多个单词用_分隔
eg. USER_GENDER

B. 项目中各个包的命名规则:
目的:包的命名应当体现良好的资源划
包名: 公司名称.开发组名称.项目名称.功能包名
cn.baidu.prjectreport......

VIEW :视图层
公司名称.开发组名称.项目名称.view / 公司名称.开发组名称.项目名称. ui
e.g cn.baidu.prjectreport.view

CONTROL : 控制层
公司名称.开发组名称.项目名称.action
eg. cn.baidu.prjectreport.action

MODEL:模型层
JAVABEAN 接口命名规范:
公司名称.开发组名称.项目名称.vo
cn.baidu.prjreport.vo.IUserInfo (接口用"I" 开始)
JAVABEAN 实现接口命名规范
公司名称.开发组名称.项目名称.vo.impl
cn.baidu.prjreport.vo.impl.UserInfoImpl
数据访问层接口命名规范
公司名称.开发组名称.项目名称.dao
cn.baidu.prjreport.dao.IUserDAO
数据访问层实现接口命名规范
公司名称.开发组名称.项目名称.impl
cn.baidu.prjreport.dao.impl.UserDAOImpl
公共类包
公司名称.开发组名称.项目名称.global
工具类包
公司名称.开发组名称.项目名称.comm/ 公司名称.开发组名称.项目名称.util

以下几个包是属于web程序的

servlet:放置项目中的servlet类
eg. cn.baidu.prjreport.servlet.UserLoginServlet
web.xml中
<servlet>
<name> camel 命名法</name>
</servlet>
<servlet-mapping>
<url-partern> [目录名/]xxx.let |全小写 </...>
</...>

filter:放置项目中的 filter 类
eg. cn.baidu.prjreport.filter.EncodingFilter
web.xml中
<filter>
<name> camel 命名法</name>
</filter>

tag:放置项目中的自定义标签类
eg. cn.baidu.prjreport.tag.ForTag
mytag.tld
<tag>
<name>forTag</name>
....
</tag>
listener 放置项目中的监听器类
eg. cn.baidu.prjreport.listener.CalcUserListener

jsp页面命名:
a. jsp页面以小写字母开始
前台:
1.(给客户用的)jsp与html文件名全部小写
eg.userlogin.html
2、数据/内容显示页
名词形式,多个单词用下划线分隔,要求能说明显示内容的信息,为避免冲突,可加上 "_list"或者其他的单词。
例如:
news_message.html 或 file_list.jsp
3、操作处理页
命名格式:名词_下划线_动词,例如:file_delete.jsp
注意:名称最好从范围大到小命名(或者是模块名_子模块名_操作的方式),比如service_order_delete.jsp,这样子当jsp页面很多的时候,容易检索和识别。


后台:面对管理员的:对应予于哪一张表,就用那张表的名字+操作词作为这个jsp的名字,pascal命名法
userdelete.jsp

web项目结构
WebRoot:
js:存放js
css:存放 css 样式表
imgs:存放图片
WEB-INF:
tlds:自定义标签的描述文件
lib:需要的包

css的命名规范:
1.全部使用小写,不缩写,多单词用一横杆隔开,例如"team-culture-title";
2.使用设计文档提供的功能列表+页面结构来给id或class命名;
3.准确使用id和class,一个页面中id只有唯一的一个,而class是可以重复出现的,也是是说id是控制唯一对应的一个节点的性质,class控制有相同性质的节点。
常用的部分命名:
总体:
头:header  
内容:content/container  
尾:footer  
导航:nav  
侧栏:sidebar
栏目:column  
页面外围控制整体布局宽度:wrapper  
左右中:left right center  
登录条:loginbar  
标志:logo  
广告:banner  
页面主体:main  
热点:hot  
新闻:news
下载:download  
子导航:subnav  
菜单:menu  
子菜单:submenu  
搜索:search  
友情链接:friendlink  
页脚:footer  
版权:copyright  
滚动:scroll  
内容:content
标签页:tab
文章列表:list
提示信息:msg
小技巧:tips
栏目标题:title
加入:joinus
指南:guild
服务:service
注册:regsiter
状态态:status
投票:vote
合作伙伴:partner

页面结构:

容器: container
页头:header
内容:content/container
页面主体:main
页尾:footer
导航:nav
侧栏:sidebar
栏目:column
页面外围控制整体布局宽度:wrapper
左右中:left right center

导航 :

导航:nav
主导航:mainbav
子导航:subnav
顶导航:topnav
边导航:sidebar
左导航:leftsidebar
右导航:rightsidebar
菜单:menu
子菜单:submenu
标题: title
摘要: summary

功能:

标志:logo
广告:banner
登陆:login
登录条:loginbar
注册:regsiter
搜索:search
功能区:shop
标题:title
加入:joinus
状态:status
按钮:btn
滚动:scroll
标签页:tab
文章列表:list
提示信息:msg
当前的: current
小技巧:tips
图标: icon
注释:note
指南:guild
服务:service
热点:hot
新闻:news
下载:download
投票:vote
合作伙伴:partner
友情链接:link
版权:copyright