项目 命名规则(转)
  DSURo2ZuqP72 2023年11月02日 32 0


命名规则

 

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

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

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

 

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)

【版权声明】本文内容来自摩杜云社区用户原创、第三方投稿、转载,内容版权归原作者所有。本网站的目的在于传递更多信息,不拥有版权,亦不承担相应法律责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@moduyun.com

  1. 分享:
最后一次编辑于 2023年11月08日 0

暂无评论

推荐阅读
  4crWjjQBqFOy   2023年11月13日   28   0   0 javamavenandroid
DSURo2ZuqP72