工程代码规范和更新规范

java的共性规范是必须要遵守的,如命名规范,命名规范包括变量命名、包命名、类命名等;

共性的就不多说了,类名要首字母大写,变量名驼峰命名法,要说的是变量名命名的时候能用英文单词拼凑就用英文单词,请尽量不要使用中文拼音的首个字母拼凑,因为汉语博大精深,其他协同合作开发的人可能不能一下子看出变量名的意思,打死!

类名命名也是,尽量使用英文单词拼凑,要一下子能看出来它的意思和作用;

涉及到框架分层的,还要注意类名要体现出来,如业务管理层一般是**Action,业务逻辑实施层一般是**Service,数据访问层一般是**Dao,接口类的实现类一般是**Impl等;

还有涉及到框架分层的,请一定代码封装,不要“堆放”在一起,就是在业务管理层**Action中请不要出现业务逻辑实施层**Service中的代码,执行sql语句进行数据访问的Dao层一般都是会封装好的;

建包也要注意归类,不要动不动就建一个package,要将所有的类进行归类,可以按功能属性归到一个package下,如工具类**Utils的package包,也可以按照功能模块分类,如UserModule,这个package包里面可以有子目录,存放的类是人员模块的所有实体类、业务管理类、业务实施类以及一些相关的代码的类;

说到更新系统的规范,一定要做好备份记录是肯定的了,数据库执行脚本时候也要做好相关的数据库备份或者某一张表结构和数据备份等,需要做的是可以建一个单独的数据库脚本更新文档,每次所执行的数据库脚本进行记录,有迹可循,如:

代码不规范,同事两行泪;

原文地址:https://www.cnblogs.com/wmqiang/p/10543788.html

时间: 2024-10-12 16:49:28

工程代码规范和更新规范的相关文章

PHP代码、文件命名规范

命名规范 开发的过程中应该尽量遵循下列命名规范: 类文件都是以.class.php为后缀(这里是指的ThinkPHP内部使用的类库文件,不代表外部加载的类库文件),使用驼峰法命名,并且首字母大写,例如 DbMysql.class.php: 类的命名空间地址和所在的路径地址一致,例如 Home\Controller\UserController类所在的路径应该是 Application/Home/Controller/UserController.class.php: 确保文件的命名和调用大小写一

JMeter工具基础知识篇-工程目录结构及命名规范

转载于金阳光测试 背景说明:我们在开展自动化或者性能测试的时候,往往具有随意性,打开JMeter工具,生成一个脚本文件,参数化配置后,然后连同数据文件一起,放在一个大目录下,然后打包一起执行.想想这样会存在什么问题: 1.一旦养成随意性的习惯,很难改变,随意建目录,随意命名,逐渐让自己沦为具有随意性操作的小作坊式自动化测试人员,所以总觉得自己的知识库是那么的乱乱乱: 2.一个自动化项目规模小的时候,随意性导致的恶习还体现不出危害性,但是一旦脚本和数据文件增多,变更频率增大后,连自己写的东西估计都

PHP 代码规范、流程规范、git规范

代码规范.git规范.teambition规范.yii规范 1. 命名规范 (1).变量命名规范 1.变量使用驼峰命名法 禁止使用拼音或者拼音加数字 2.变量也应具有描述性,杜绝一切拼音.或拼音英文混杂的命名方式 3.变量包数字.字母和下划线字符,不允许使用其他字符,变量命名最好使用项目 中有据可查的英文缩写方式, 尽可以要使用一目了然容易理解的形式: 4.变量以字母开头,如果变量包多个单词,首字母小写,当包多个单词时,后面 的每个单词的首字母大写. 例如 :$itSports 5.变量使用有效

代码书写规范和命名规范

上一篇给大家分享了一下,关于文档编写的几个概念.这篇文章阐述如果编写代码书写规范以及命名规范文档.[以java语言为例] 1.代码书写规范 代码书写规范,能够让不同的人,写出相同风格的代码.很多人都看过java源代码,你会发现java源代码的整体风格几乎是一致的,但是你要知道编写源代码的人是很多的,如何才能让他们写出同一风格的代码呢?这就是代码书写规范的作用. 代码书写规范描述的是如何从头到尾书写代码(自己定义的).通俗点讲就是如何书写java文件.就像你写毕业论文一样,从头到尾每个细节都是有要

Pycharm配置autopep8教程,让Python代码更符合pep8规范

一.何为pep8? PEP 8官方文档 -- Style Guide for Python Code PEP8中文翻译(转) 二.Pycharm中配置pep8 Pycharm本身是有pep8风格检测的,当你敲得代码中不符合规范时,会有下划波浪线提示.如何让代码修改为符合规范,去掉这些难看的波浪线呢?下面介绍步骤: 2.1安装autopep8 cmd窗口输入:pip install autopep8 2.2在Pycharm中安装autopep8配置 Tools→Extends Tools→点击加号

unity3D 游戏开发之工程代码框架设计思路MVC

unity3D 游戏开发之工程代码框架设计思路MVC 设计目的 1.使工程结构更规范. 2.提高代码可读性,封装性,拓展性 3.提高工作效率. 正文内容: 1.Frame的组成结 (1)视图层(View) (2) 控制层(Control) (3)数据层(Model) 整个Frame是由这三个部分组成,每一层管理属于自己的逻辑,核心思想是游戏逻辑和UI 逻辑独立开.目前遇到的项目工程大多数View和Control逻辑都写在一起,这样后期修改 和维护效率会很低,因为耦合性很高而View又是经常要修改

《从零开始学Swift》学习笔记(Day 57)——Swift编码规范之注释规范:

<从零开始学Swift>学习笔记(Day 57)--Swift编码规范之注释规范:文件注释.文档注释.代码注释.使用地标注释 原创文章,欢迎转载.转载请注明:关东升的博客 前面说到Swift注释的语法有两种:单行注释(//)和多行注释(/*...*/).这里来介绍一下他们的使用规范. 文件注释 文件注释就在每一个文件开头添加注释,文件注释通常包括如下信息:版权信息.文件名.所在模块.作者信息.历史版本信息.文件内容和作用等. 下面看一个文件注释的示例: /* Copyright (C) 201

Swift— Swift编码规范之命名规范-备

程序代码中到处都是自己定义的名字,取一个有样并且符合规范的名字非常重要. 命名方法很多,但是比较有名的,广泛接受命名法有: 匈牙利命名,一般只是命名变量,原则是:变量名=类型前缀+描述,如bFoo表示布尔类型变量,pFoo表示指针类型变量.匈牙利命名还是有一定争议的,在Swift编码规范中几本不采用匈牙利命名. 驼峰命名(Camel-Case),又称骆驼命名法,是指混合使用大小写字母来名字.驼峰命名又分为:小驼峰法和大驼峰法. 小驼峰法是第一个单词是全部小写,后面的单词首字母大写,如:myRoo

JavaSript模块规范 - AMD规范与CMD规范介绍

JavaSript模块化 在了解AMD,CMD规范前,还是需要先来简单地了解下什么是模块化,模块化开发? 模块化是指在解决某一个复杂问题或者一系列的杂糅问题时,依照一种分类的思维把问题进行系统性的分解以之处理.模块化是一种处理复杂系统分解为代码结构更合理,可维护性更高的可管理的模块的方式.可以想象一个巨大的系统代码,被整合优化分割成逻辑性很强的模块时,对于软件是一种何等意义的存在.对于软件行业来说:解耦软件系统的复杂性,使得不管多么大的系统,也可以将管理,开发,维护变得"有理可循".