项目命名规则

命名规则

这里规定并说明了设计,编写代码时的命名规则。所有开发人员必须无条件

遵守,并按照这个命名规则来命名。如有不足,不合理请提出来,项目开始

之前可以更正。※本文没有特别声明的英文字母,和阿拉伯数字全是半角。

1.基本设计工程

1.1.画面命名

项目代号[3位] + 模块代码[3位] + 页面数字[2位] 共 8位

项目代号[3位]:THP[TongshidaHomePage]

模块代码[3位]:A01[首页] B01[公司简介],B02[公司沿革],

页面数字[2位]:THPB0101[公司简介页面], 

THPC0101[留言版显示页面],

THPC0102[留言版更新页面],

※数字要从01开始递增,无00页面。

1.2.数据库命名

数据库名:项目代号[3位] + "DB"(THPDB)

表命名:易懂的小写英文名名词,例如userif,department 字段名:

使用若干个易懂的小写英文名。例如userid,username,departid,

2.详细设计工程

2.1.程序名

1)Action程序命名:画面ID[8位] + Action名[若干位] + Action.java

(1)画面ID[8位]:同[1.1.画面命名]

(2)Action名[若干位]:开头字母大写。

共同命名:开头大写,后面小写 自由命名:

(3)Action程序最后必须添加[Action.java]来表示它是Action程序。

(4)最终取名例子:

例)THPB0101InitAction.java

[公司简介页面-初期处理Action]

THPB0101SearchAction.java

[公司简介页面-检索新闻处理Action]

2)FormBean程序命名:画面ID[8位] + Form名[若干位] + Form.java

(1)画面ID[8位]:同[1.1.画面命名]

(2)Form程序命名[若干位]:开头字母大写。 共同命名: 自由命名:

(3)FormBean程序最后必须添加[Form.java]来表示它是FormBean程序。

(4)最终取名例子:

例)THPB0101MainForm.java

[公司简介页面-主要内容FormBean]

THPB0101NewsListForm.java

[公司简介页面-新闻检索结果集FormBean]

THPB0101NoticeListForm.java

[公司简介页面-公告检索结果集FormBean]

3.代码工程(PG工程)

3.1 .Java文件包的结构(目录结构)

1)包名必须全部是英文小写,下面是包的结构

/com

/tongshida

/common

/comp

/db

/comweb

/THPB0101

/action

/form

/THPC0101

2)[com.tongshida]: 表示这个包以下是,通事达公司所有或通事达公司

开发,com是公司的意思

3)[com.tongshida.common]:这个包以下放置,可以和别的项目也就是将来

开发时能重复使用的程序。比如共同函数等。

4)[com.tongshida.comweb]: 放置只能用于这次项目开发里的,和以后别

的项目无法或很难重复使用的Java程序。比如具体业务逻辑。

5)[com.tongshida.comcom.comp]: 放置能在以后项目中可重复使用的共同

函数。

6)[com.tongshida.comweb.画面ID]: 以画面为单位,分开放置本次开发项

目的业务逻辑部分的Java程序。

7)[com.tongshida.comweb.画面ID.action]: 放置画面的动作实行对象,

也就是Action对象(也就是Action的Java文件)。

8)[com.tongshida.comweb.画面ID.form]: 放置画面数据的FormBen对象

(也就是ActionForm的Java文件)。

3.2.Import 的命名规则

1)Import 里头不许用[*],要把所有使用到的对象全都罗列出来。

2)和Import无关,但写SQL文当中select文时,也不允许写select *, 必须

把要检索出来的字段名都写出来,1个字段或100个以上字段都得罗列字

段名。例)select username,password,age from userif 不能写

select * from userif

3.3 .对象名称

1)对象名(Class名)必须与文件名(java文件)一致.

例如,THPB0101InitAction.java 文件里的对象必须是

HPB0101InitAction.

3.4 .变量的命名规则

1)static final常量的命名:

(1)必须全部大写

(2)由多个英文单词组成时,要以下划线[_]分割

例如,DBSERVER_USERID,DBSERVER_PASS

2)起普通的变量名称:

(1)由多个英文单词组成时,开头单词要小写,后面的单词开头都大写。

例)String userName = "Tom"

(2)for循环中使用的变量,原则上适用小写 i,j,k。

例)for (int i = 0; i < sales.length; i++)

3)对象变量的名称:

(1)原则上去掉画面ID后,头字母小写使用。

例)THPB0101MainForm mainForm = new THPB0101MainForm();

(2)尽量能在变量名中显示变量的对象名称。

例)ResultSet newsListRs = new ResultSet();

3.5 .方法的命名规则

1)开头英文字母要小写,每个单词开头要大写

2)开头的英文单词要以动词开始,后面一般跟着名词英文单词

例)setName(),getPass()

3)取名时一般要遵守一下动词单词的对称性

add<=>remove,insert<=>delete,get<=>set,start<=>stop,begin<=>end,

send<=>receive,first<=>last,put<=>get,up<=>down,show<=>hide,

source<=>target,open<=>close,等等...以外也有很多

3.6 .JSP画面的目录结构。

1)JSP目录结构。

/项目名

index.jsp

/JSP

/THPA01

THPA0101.jsp

THPA0102.jsp

/THPA02

THPA0201.jsp

THPA0202.jsp

3.7.不好的无意义的命名。

1)光用以下单词的命名。

Info 修正后 userInfo,guestInfo,studentInfo

Data 修正后 newsDataRS(RS是 ResultSet)

C++也类似

时间: 2024-10-11 15:55:47

项目命名规则的相关文章

Java项目命名规范(简洁版)——高薪必看

作为一个优秀的项目经理或项目带头人,必须养成良好优秀的项目命名规则和习惯.接下来把查到的资料整理一下,实际上,在很多项目中,也是遵循以下的规则. 一.项目名 全部小写,比如cms.workdesk,jobserver等 二.java相关命名 a.类命名:每音节单词前的第一个字母大写,比如FieldInfo.Expression等\ b.普通变量(包括spring里的变量引用命名):第一个单词前小写,以后每个单词第一个字母大写,password,primaryFlag c.静态变量:全部大写,多个

[转]软件项目版本号的命名规则、格式介绍及管理策略

转自:http://www.flighty.cn/html/net/20121029_163.html 轻狂注:各种软件的版本号经常搞得使用者云里雾里,不知道软件的开发者到底是如果定义自己软件的版本的,所以,有必要把软件版本号命名规则方面的常识列一下. 版本控制比较普遍的 3 种命名格式 : 一.GNU 风格的版本号命名格式 : 主版本号 . 子版本号 [. 修正版本号 [. 编译版本号 ]] 英文对照 : Major_Version_Number.Minor_Version_Number[.R

MS SQL开发命名规则

下面的SQL开发命名规则是我自己开发时总结.整理出来的,以后的开发过程中将不断完善.修改.也希望各位网友指点.批判. 纲领: SQL 语句关键字全部大写, 命名规则建议使用Pascal Case 或 每个单词使用下划线_隔开,不建议全部使用小写.尽量少使用特殊字符比如数字.空格等 使用英文或英文缩写,不建议使用拼音.尽量见名知意. 1:    数据库名命名规则 (1.1)  数据库名用产品名称或项目名称   尽量用名词,见名知意 :MyAssistant  我的个人助手            

.NET 基础 一步步 一幕幕 [注释、命名规则、访问修饰符、数据类型、常量、变量]

注释.命名规则.访问修饰符.数据类型.常量.变量 话说一个不会写注释的程序猿的不是一个好吃货,我们本篇就从注释开始说起好了. 在C#中有三种注释: 第一种:单行注释  以//开头,后面的就是注释内容 –  //单行注释 –  第二种:多行注释  以 /*开头   */结束 之间的是注释内容 –  /*  */多行注释 –  第三种:文档注释  在方法或类的上一行输入 ///就会产生 –  /// –  ///文档注释 –  /// –  So....截图就是这三种注释的用法了. 再来说说命名规则

[转]程序开发基础学习二(C++ Google Style 命名规则)

无规矩不成方圆,新的岗位就需要服从团队的编码规则.很开心团队用的是Google的C++编码规则,大概看了下Google 的编码规则,正如九天翔雁说的:“Google的 C++ Style Guide远不仅是一个传统意义上的代码书写风格指导,对于C++的方方面面做出了Google的解释和使用建议,包括每个规则给出时,较为详细的讲了这个规则好的一面和不好的一面,最最激进的规则甚至有禁用C++的异常,以及除了Google规范的Interface作为基类外,禁用多重继承,在绝大部分情况下禁用默认参数等内

Java包命名规则

初次学习Java的时候直接上手了一个小项目,因此Java的基本功不是很扎实.但,在接触参与比较大的项目时,代码命名规则常常是一个大问题.合理规范的命名规则,一来显得自己逼格高上:二来方便后检查,看到名称就知道是什么类型.使用是否正确等:最后又可以供其他人参考,提高代码可读性.最近在新建Java Project的时候突然想到了Java Package的命名,于是翻阅资料................. Java package的命名规则全部使用小写字母,包括中间的字也是如此(Java Class

Java命名规则详细总结

Class名应是首字母大写的名词.命名时应该使其简洁而又具有描述性.异常类的命名,应以Exception结尾.Interface的命名规则与Class相同 1. JAVA源文件的命名 JAVA源文件名必须和源文件中所定义的类的类名相同. 2. Package的命名 Package名的第一部分应是小写ASCII字符,并且是顶级域名之一,通常是com.edu.gov.mil.net.org或由ISO标准3166.1981定义的国家唯一标志码.Package名的后续部分由各组织内部命名规则决定,内部命

thinkphp学习笔记1—目录结构和命名规则

最近开始学习thinkphp,在下不才,很多的问题看不明白所以想拿出来,恕我大胆发在首页上,希望看到的人能为我答疑解惑,这样大家有个互动,学起来快点,别无他意,所谓活到老,学到老,希望各位不要见笑啊. 我的做法很简单,先从手册开始,手册是开发thinkphp作者辛勤劳动的成果,但是有些地方是在是不懂,如果有幸各位也遇到类似的问题希望能回复.thinkphp手册地址:http://doc.thinkphp.cn/manual.html 1.框架目录 在章节1.6 目录结构,内容如下: 新版的目录结

CSS 命名规则

随着CSS的发展,使用CSS有语义化的命名约定和CSS层的分离,将有助于它的可扩展性,性能的提高和代码的组织管理. 在我前面的文章中讨论很多关于CSS的问题都可以通过使用一个适当的CSS策略来避免.在这篇文章里,我将着重于讨论使用一种方法或者一个命名规则所带来的好处. 这里有很多可供使用的前端方法和命名规则,每个都有自己的优缺点.在几乎所有的案例中CSS被分割成更易于管理的代码“块”.CSS的这种分割方式定义了每一种方法. 命名规则 一个可靠命名规则的重要性是不可忽视的.就像组织结构带来的好处一