当一个程序员在互联网行业工作了足够长的时间时,最终您将不得不使用从别人那里继承来的代码。不管这是另一家公司的移交过程的一部分,还是后来由自由职业者编写的开发人员编写的文件,迟早都会发现自己未编写的代码逐行筛选。
发生这种情况时,很容易陷入消极的心态。它可能使用的是你不熟悉的结构,看起来过于复杂,杂乱无章,或者与你的常规开发方法不同——反正很少会一帆风顺。
使用稍微不同的方法构建的内容可能很快变得难以管理“这不是我的错,这已经是一团糟”——如果你不小心的话,以这种态度放松自己会造就弗兰肯斯坦的网站怪物。如果每个从事该项目的开发人员都添加他们的主观方法,则使用略有不同的方法构建的内容很快就会变得难以管理。无论是命名约定,类标识符还是JavaScript函数。
以下是一些技巧,可帮助你准备和管理继承的网站,并将其视为需要培育而不是令人恐惧的事物。
1.很好地询问文件
网站的文档通常以某种形式存在于某处。希望!它可能已经过时,但是任何事物总比没有好。收到站点的代码库时,请始终确保尽早提出此问题,以确保在移交过程中提供所有文档。
2.尽早投资时间
花一些时间来了解你收到的代码。不要只是看一眼。花时间真正看一下文件结构,CMS,任务运行器以及网站是否依赖任何模板引擎。
如果该站点尚不存在,那么这是个不错的时机,或者将你自己的注释添加到任何现有文档中。
你将无法成功地对你不了解的网站进行更新。结果将是混乱的,bug缠身的代码,这只会延长执行最小的任务所需的时间。
确保你知道站点地图,有多少页面以及这些页面的代码在结构中的位置。这将帮助你确定可以删除的任何过时或未使用的代码。还要检查未使用的JavaScript库。较旧的网站,或拥有多个开发人员或代理机构的网站,通常可能会带来很多超重行李。你可以整理或清理的所有内容都将无可否认地有益于该站点的使用寿命。
3.解决未知功能
不要等待它破裂!查看网站上所有令人恐惧的功能,并确保你完全了解所有复杂的API集成。确保已清楚理解并记录了这些内容。
使用此功能时,请在代码中添加或更新注释,以清楚说明哪些功能在做什么以及为什么工作;节省了你自己和其他人在每次选择项目时都无需弄清楚的问题。
4.保持一致
了解系统并调整代码编写习惯以适应当前样式。熟悉可重用的类和函数,因此你不会重复任何代码。如果将站点传递给另一个开发团队,这将有助于减少总体负担,延长使用寿命并提高可读性。
将你自己的编码方法添加到继承的站点将使其他开发人员难以接受。因此,尽管调整方法似乎违反直觉,但在这里灵活做事确实是有益的。
5.花一些时间在分析中
重要的是要使自己尽可能多地熟悉网站,并且深入分析可以为您提供许多有用的信息。了解用户正在查看哪些设备以及哪些浏览器需要支持。尽早掌握这些知识,意味着你会在新工作进行时做好准备,并知道要进行哪些后备测试并可以进行测试。
始终通过站点速度测试来运行站点,以标记所有主要的性能问题。你可以实施一些快速改进来改善网站——例如优化大图像或缩小CSS或JavaScript文件。
6.不要以“其他人建造的东西”为借口
我们需要摆脱编写糟糕的,懒惰的代码的习惯,因为“这已经很糟了”。创建一个噩梦项目不是你的更广泛的团队想要接触的东西。我们都编写了某些时候并不引以为豪的代码,通常是出于我们无法控制的原因。
我们都编写了我们并不特别引以为豪的代码…紧迫的最后期限,范围不断扩大以及客户难以接受只是影响网站构建质量的几个因素。摆脱寻找别人的责任,而专注于改善自己所拥有的方式。始终以工作为荣。
从长远来看,无论是从头构建还是继承,你投入任何站点的时间和精力都将获得回报,因为它创建了一个可读性,可维护性的项目。你、你周围的团队和客户将从对继承站点的积极态度中受益匪浅。
因此,下一次你发现自己不得不拾起别人的代码(在你翻白眼并开始抱怨)之前,将遍历这些技巧,你可能只是将潜在的噩梦项目变成一件轻而易举的事情。
可能您还想看