代码设计时应遵循哪些原则

1提高编码质量，代码可读性和可维护性。

2代码编写规范

2.1 删除所有无用代码
2.2 必须给代码添加注释，一个类的注释字数不得小于代码的百分之20%
2.3 建议遵循30秒原则。如果另一个程序员无法在三十秒内无法知道你的函数在做什么，如何做以及为什么要这样做，那么说明你的代码是难于维护的，需要得到提高。
2.4 一个函数的代码长度不允许超过100行，超过一百行的函数建议在不破坏原子性的基础上进行拆分。
2.5 变量都应在方法或者类的头部集中定义
2.6 保证一行代码只做一件事
2.7 使用括号来控制操作符的运算顺序，以免使用java默认的操作符优先级顺序。
2.8 代码格式化：对代码进行格式化，再进行提交。
2.9 接口不允许没有方法或者变量的声明

命名规范
3.1 各种标识符的命名要使用有实际意义的英文单词或者英文单词缩写，缩写词及英文单词要收录在项目的简写词汇表中。切忌使用阿拉伯数字和拼音进行命名。
3.2 类名：首字母大写，每个单词首字母都需要大写。
3.3 方法名：首字母小写，其余单词首字母都需大写。
3.4 全局变量，和常量名称要求全部字母大写。
3.5 参数名称与局部变量基本相同，区别在于参数名称需要加上冠词a ，an 或者在单词结尾以s结束。
注释规范
4.1 注释需要注意的事项：
★注释应该用中文清晰表达意思，应该是程序看起来更清晰，更容易理解
★注释要尽量简明，避免装饰性的注释。
★注释不但要说明做什么，还应当说明为什么要这样做。最好先写注释表明要做什么，再进行编码。

4.2 类的注释
★类的用途，目的。包括其他人感兴趣的介绍。
★已知bug,当然最好是修改好所有的错误，但有时可能暂时没有办法修改，或者没有时间修改。
★开发和维护该类的历史列表，记录每一次修改的作者，日期，修改的内容。
★列举类的各种稳定状态，说明调用成员函数使类的状态产生的变迁(可选)。
★同步问题（可选）
★对主要的算法必须加以说明，主要流程必须给予引导性说明
标准格式：
如果对已经版本话的类进行了修改，需要按照如下格式为每一次修改附加修改历史记录：
// 修改人 + 修改日期
// 修改说明范例：

// 李四 2010/07/02
// 添加错误数据修改后继续批量保存的处理函数 saveBatch(
@Bind(key = “itemParams”, defaultValue = “”) String itemParams,
@Bind(key = “pid”, defaultValue = “”) String pid)。
// 王小二 2010/07/02

4.3 接口注释：
★接口的注释风格基本与类的注释风格相同；
★在别人使用接口之前，必须了解接口所包含的概念。检验一个接口是否应该定义的简单方法是：你是否能★够容易的描述接口的用途；
★接口如何应当和不应当被使用。开发者需要知道该接口如何被使用，也希望知道该接口不能被怎样使用。

4.4 函数的注释
★函数头注释必须包括：函数执行了什么功能，为什么要这样处理；函数处理过程中对对象的哪些属性
★可能进行更改；函数执行前后，对象的状态；
★比较、循环等控制结构加注释（可选）；
★在代码的功能并非一目了然的情况下，应当说明为什么要这样做；
★局部变量必须加注释；
★复杂难写的代码必须加注释；

4.5类属性的注释:
★描述域的用途。使别人知道如何去使用它；
★对于有着复杂事物规则的域，可以加入范例来说明。有时候一个简单的小例子，抵的上千言万语；

代码设计时应遵循哪些原则相关推荐

pci规划的三个原则_PCI规划应遵循什么原则？ - 51学通信网络课堂 - 通信人值得信赖的在线交流学习平台 - Powered By EduSoho...
PCI即物理小区标识.LTE系统提供504个物理层小区ID(即PCI),和TD-SCDMA系统的128个扰码概念类似.网管配置时,为小区配置0-503之间的一个号码即可. TD-LTE系统中,UE需要 ...
危机管理应遵循哪些原则？
在急速变革和传媒化社会时期,危机随时可能爆发,树立危机意识,有效管理公共危机成为社会各主体的切实主题,如何做好公共危机管理原则?危机管理应遵循哪些原则?接下来,品牌维护森算小编给大家分析一下. 1.战 ...
【电气专业知识问答】问：为什么现代大型发电机应装设过励磁保护？在配置和整定该保护时应考虑哪些原则？
[电气专业知识问答] 问:为什么现代大型发电机应装设过励磁保护?在配置和整定该保护时应考虑哪些原则? 答:大容量发电机无论在设计和用材方面裕度都比较小,其工作磁密接近饱和磁密.当变压器故障或手动调压甩 ...
必备知识：大数据处理应遵循的原则
简约原则这是牛顿创设的一条"极简主义"的节约规则.在牛顿看来,神奇的自然界在创设过程中选择的简单性和对繁琐的讨厌,使得人类也形成如下观念:"在用很少的东西就能够解决问题 ...
SEO交换链接时需遵循哪些原则？
在网站优化中,交换友情链接是优化中的重要工作,因为网站的质量和关键词的提升都离不开友情链接的支持,通过友情链接的权重传递来提升自身网站的权威性,但交换友情链接也并不是件简单的事情.下面,就带大家一起来 ...
信息论通识课程：建立过渡性的模型时应遵循最大熵原理（过犹不及）
文章目录引言 I 最大熵原理 1.1 含义 1.2 最大熵模型的优势 1.3 弊端 1.4 结论 II 最大熵原理的应用 2.1 自然语言处理 2.2 对冲基金引言要把道理总结得简单易懂,自己需 ...
计算机出现故障，维修应遵循的原则是什么？
硬件维护时应注意的事项: 1.断电后,方可对主机箱内部的部件进行拆卸. 2.注意释放手上的静电,以免损伤主板. 支持热插拔的设备普通电脑里,USB(通用串行总线)接口设备和IEEE 1394接口设备 ...
数据库设计时要遵循的一些原则
1.表及字段的命名规则 (1).可读性原则:使用大小写来格式化的库对象名字以获得良好的可读性.例如:使用custAddress而不是custaddress来提高可读性. (2).表意性原则:对象的名字 ...
工作时应遵循的几个原则
列出下面几条以自勉,随时更新: 1. 乐观此条最为重要,世界是美好的,人们之间是友好的.不管遇到多么不顺心的事,也要平心面对,时刻保持乐观的心态. 2. 自信天下牛人很多,自己是其中之一.嘿嘿! ...
网络推广是做什么的介绍网站内容更新时需要遵循哪些原则？
对于网络推广是做什么的网站优化来说,但是如果长期的.稳定的优化网站是需要站长们不断的进行学习和探索的,并且确保网站排名和权重能一直稳步提升也很重要,那么在网站的内容更新和优化的过程中,都需遵循和注意哪 ...

代码设计时应遵循哪些原则

代码设计时应遵循哪些原则相关推荐

最新文章

热门文章