欢迎来到合肥浪讯网络科技有限公司官网
  咨询服务热线:400-099-8848

进步代码质量——来看代码检查清单

发布时间:2021-01-05 文章来源:本站  浏览次数:2946

不管是网站开发,仍是软件开发,都是靠代码编程一步一步建立的,代码质量的要求有必要高。程序员常用代码检查的手法去进步代码质量,其完成在有许多的代码检查技术,网络上也也流传了许多关于如何优化代码的技术攻略,但这其中良莠不齐,今天给大家列了一份代码检查清单,梳理了适用于大多数语言的代码检查点,希望能够为程序员小伙伴快速有效地检查代码供给帮助。
代码检查的目的
代码检查的终究目的是找出代码的薄弱点和优势,然后取长补短,找出合适的办法优化代码以取得更好的功用。 它主要是供给一个无缺点(至少挨近完美)的运用程序,以满意企业要求,并一起满意行业规范。
代码检查清单

1. 完成企业要求
代码能够满意企业要求这是基本的要求。
2.牢不可破,合理验证
验证是很必要的。代码在任何状况下都不会中止,所以在遇到来自用户端的无效输入的也不会中止,否定的、过大的或者无效的格式输入应该在进一步处理之前就整理完成,在拜访之前,应该要检查每个目标的实际数据是否合理。
3.处理呼应
不该只是对服务器回来的过错音讯进行处理,服务器回来的一切呼应都应该处理,而且它还应该具有标题,呼应音讯,过错代码以及任何其他必要的细节。在测试时要尽量全面的考虑到一切状况,来防止死锁,超时等状况。
4. 结构规划,无规划偏差
运用软件规划与功用完成阐明文档是程序规划首要做的工作,代码的编写一定要严格遵从此文档,假如呈现任何规划更改的状况,那么在现有代码完成之前,就要对其进行记录和规范化。
5. 单元测试可靠
每个中心办法都要经过单元测试,保证这些办法都是可用的。
6. 防止代码重复
在代码完成的过程中,程序中很可能会呈现需求完成相同功用的部分,这时,咱们能够考虑把这些相同代码写成函数,然后直接调用,防止代码重复。
7. 快速呼应和可扩展性
运用程序的呼应应该是快速的:请求和呼应之间没有长期的推迟、防止原始字符串衔接;代码是可扩展的,能够处理大量的数据和未来可能需求增加的功用。
8.代码安全
保证代码在加密认证、角色、未经授权的拜访、目录浏览、SQL注入、跨脚本等方面是安全的,并遵从OWASP安全原则。
9.可办理
代码可读性强,有适当的注释且易于办理,办法的巨细不超过可读范围。
10.规范化办法
遵从编码常规和规范,与现有的运用程序代码是共同的,而且不该该存在已被注释了的代码和硬编码。
11.内存处理
在运用完毕后未主动开释的资源将被开释。衔接,端口正确关闭。
12.可追溯性
记录每笔买卖或需求记录的日志,然后存储在存储库(作为文件)以及数据库(作为文本)中。能够在配置文件(例如web.config)中启用或禁用不同阶段的版别。
13.代码覆盖率大于95%
代码覆盖与单元测试用例一样重要。 95%的代码被覆盖意味着95%的代码实际上是经过单元测试用例测试的。
14.快速
仅供给需求就能够便利的获取资源,必要时能够处理庞大的数据,如分页等。
15.数据安全
运行运用程序时不会呈现编译器正告。清除开发过程中运用的日志,而且不会在浏览器操控台中写入任何运用程序信息,特别是灵敏的信息。
16.第三方东西答应
在必要时运用程序可能会运用外部库,假如它是第三方东西,那么它的答应证和法律用途有必要合规。
高质量的代码不仅能够彻底满意用户的要求,一起它在可扩展性和快速呼应方面也应该表现出色。在这个各种追求速度的糙快猛创业公司遍地的世界,假如你能真实的沉下心来写好代码,锋芒毕露指日可下。

上一条:如今仍然存在的十大过错网...

下一条:不同网站、APP等项目建...