提高代码的可维护性和产出质量-结合实际中遇到的坑来总结

简介:   以后慢慢添加经验。随手把遇到的问题记录下来。    一、地址要定义在变量中,千万不要写死在代码中。   遇到一个坑。把地址都写死在模版或代码中了。以后要修改地址,变得很困难   下面是遇到的问题,要将通行证的地址修改为新版本的地址,这个应用中代码请求要改为请求新版本的地址。

 

 

以后慢慢添加经验。随手把遇到的问题记录下来。

 

 一、地址要定义在变量中,千万不要写死在代码中。

 

遇到一个坑。把地址都写死在模版或代码中了。以后要修改地址,变得很困难

 

下面是遇到的问题,要将通行证的地址修改为新版本的地址,这个应用中代码请求要改为请求新版本的地址。我去修改的时候,就变得麻烦。要修改的地方非常多。

 

 

解决办法:把地址定义在一个变量中。多处使用地址的时候,就引用这个变量。

定义一个js变量放在头部模版中定义。这样模版的其他地方引用这个变量。这个js变量的值来源于后端php赋值。

 

以后要修改,就方便多了。直接在php中修改即可了。

 

 

二、文件的命名要清晰表达意思。不要用拼音,拼音很难识别含义。也尽量不要使用简写。比如简写o,很难知道这个o表达什么意思。

 

header.php,我去维护的时候,发现多了一个oheader.php。

 

看文件名称很难知道这个文件是干嘛的

 

去看代码,里面差不多。只是疑惑了:不知道为什么,有的引入的是header.php,有的引入的是oheader.php

区别是什么呢?接手的技术很难明白。

 

 

 

代码的维护性减低了很多。

 

 

 三、多余的文件不要残留在目录里面。尽量避免拷贝文件重命名的方式

 

 

-----------------------------------

 

其实这些知识与技术知识的无关。不是技术知识的部分。是人做事情的一种条理性和思路清晰的体现。乱的代码体现了一个人大脑是乱的,没有清晰的规划。

比如说,多思考某一天修改了域名怎么办呢?考虑到变化的部分。

 

路径其实不会修改。域名修改是很正常的。因为还会是同一套系统,那么里面的路径是一样不会变的。所以我们常常会习惯把域名部分定义成变量。

 

 

 

我的经验是,同理心思考(换位思考):怎么样让自己写的代码清晰,容易让接手的技术明白呢?我会特意问对方哪里不容易理解。这样验证自己哪里做的不够好。哪里还可以更加通俗化点,比如需要增加一些注释特意说明。

站在接手你代码的人角度去考虑问题。这样自己写的代码不会被对方给鄙视。

 

大道至简啊。把复杂的事情通俗化,简单化,这样能够锻炼出自己的能力。

 

目录
相关文章
|
8月前
|
测试技术
测试遗漏是能力问题?
测试遗漏是能力问题?
43 1
|
2月前
|
设计模式 安全 测试技术
Swift代码审查的关键点及最佳实践,涵盖代码风格一致性、变量使用合理性、函数设计、错误处理、性能优化、安全性、代码注释等方面,旨在提升代码质量和项目管理水平
本文深入探讨了Swift代码审查的关键点及最佳实践,涵盖代码风格一致性、变量使用合理性、函数设计、错误处理、性能优化、安全性、代码注释等方面,旨在提升代码质量和项目管理水平。通过实际案例分析,展示了如何有效应用这些原则,确保代码的高可读性、可维护性和可靠性。
35 2
|
3月前
|
Web App开发 移动开发 前端开发
前端代码规范和质量是确保项目可维护性、可读性和可扩展性的关键(一)
前端代码规范和质量是确保项目可维护性、可读性和可扩展性的关键(一)
72 0
|
3月前
|
Web App开发 前端开发 JavaScript
前端代码规范和质量是确保项目可维护性、可读性和可扩展性的关键(二)
前端代码规范和质量是确保项目可维护性、可读性和可扩展性的关键(二)
66 0
|
3月前
|
前端开发 JavaScript 开发工具
前端代码规范和质量是确保项目可维护性、可读性和可扩展性的关键(三)
前端代码规范和质量是确保项目可维护性、可读性和可扩展性的关键(三)
47 0
|
4月前
|
测试技术 数据库连接 数据库
提升软件测试效率与灵活性:探索Mock测试的重要性
【9月更文挑战第20天】在软件测试领域,提升测试效率与灵活性至关重要。Mock 测试通过模拟外部组件,使模块能独立测试,缩短测试周期;快速反馈机制让测试结果即时可见,加速问题修复;还能模拟异常情况和进行参数化测试,增强测试全面性与灵活性,从而显著提高软件质量和开发效率。
|
5月前
|
测试技术
质量标准化实践问题之确保项目进度和质量受控如何解决
质量标准化实践问题之确保项目进度和质量受控如何解决
45 2
|
5月前
|
测试技术 UED
质量标准化实践问题之测试策略的本质如何解决
质量标准化实践问题之测试策略的本质如何解决
32 2
|
5月前
|
测试技术 开发者
单元测试问题之单元测试想提高协同效率与质量,如何实现
单元测试问题之单元测试想提高协同效率与质量,如何实现
|
6月前
|
测试技术 开发者
单元测试问题之为什么单测覆盖率高的项目模块更易于迭代演进
单元测试问题之为什么单测覆盖率高的项目模块更易于迭代演进