如果您是专业的Web开发人员,那么在某种程度上,您可能需要维护另一位开发人员编写的代码块或脚本。你花了几个小时尝试读懂他的代码?你的初步回答是“这是疯了吗?”如果你曾经听说过另外一个团队成员的名字用作描述坏代码的动词或形容词,而你不想在某个时候成为那个人 - 你已经明白了写清洁代码的重要性。重庆网页设计公司及重庆网站制作公司每个网站的代码都是我们自己敲写的,都具有非常高的可读性、维护性。
作为开发人员,您不仅对代码的结果负责,还对底层组件的完整性负责。创建一个符合目标的代码块是可能的(而且通常更快),否则这些代码无法理解。遇到错误的代码工作的截止日期 - 也就是说,直到您或另一个开发人员必须返回到更新代码或更正错误的代码。虽然创建干净可读的代码在前端增加了一点时间和考虑,但一定会节省您的时间。当您敲击您的下一个主题或插件时,请注意以下一些简单的事情。
重点和意图
当您清楚自己的发展方向和原因时,可以帮助您组织和维护干净的代码。尝试将大量功能的代码组合成更容易理解和维护的较小块。可以独立运行的较小的逻辑块将缩小错误的边距与一个大的联锁文档。
为了说明,想想一辆汽车。一辆汽车是由独立的系统组成的一台大型机器,一起工作,整体运行。如果你正在编写一个模仿汽车的应用程序,理论上可以把每一行代码都放在单个文件中,一个名为“car”的函数,但是这种方法并不认为汽车由发动机,变速器,轮子组成,车头灯等。如果您需要在引擎上工作,则不会同时处理传输,所以将名为car.php的文件命名为一个名为车()所描述的(发动机,变速器,车轮,前大灯等)轿厢执行的每一个操作。一个更好的方法是将汽车功能分解成更为集中的功能,如engine(),headlights()或wheel())。要进一步组织car.php,您可以将集中的功能移动到单独的文件:engine.php,headlights.php等。最后,您会有更小的代码块,其意图更加明确。你不需要挖整个车,只是修理车轮。
清晰度代码注释
我听说很多开发商通过限制他们键入的字符数量来保护他们的乱码,声称他们可以节省时间。这种节省时间的措施的形式是模糊的一个或两个字母的变量名称,不传达其目的的函数名称,或完全没有注释。代码在编写时可能被开发人员理解,但没有其他人会有任何上下文。当一个星期或一个月后修改或重构这个代码的时候,有人要解开混乱。这么多,以节省时间。
因为变量和函数可以被声明为远离它们所使用的许多行或文件,所以这些变量和函数的模糊名称可以(并将会丢失上下文,如果它们不描述其目的),所以当编写函数或变量名时,尝试使用描述性文本将其保留在上下文中。一个名为“myFunction”的函数只传达你(或其他人)写了一个函数。相比之下,“myFunctionThatAddsTwoNumbers”是一个功能名称,可以解释它的作用。没有进一步挖掘代码,你知道该函数将添加两个数字。这也扩展到变量; 如果你把艾菲尔铁塔的纬度保存在一个变量上,一个好的名字就像“latitudeOfTheEiffelTower”一样。或类似的东西描述变量包含什么。
提高代码清晰度的另一种方法是使用注释直接记录。复杂的代码具有很好的自我记录命名仍然难以阅读和理解,所以即使是一个小的评论也可以帮助其他开发人员了解。如果代码由嵌套的条件语句或循环组成,那么对编程语言的熟悉并不总是足够推导出应用于该问题的解决方案。一个简短的评论来解释一个陈述结束或描述一个部分如何与另一个部分相关联,可以很大的方向来引导他人通过你的代码很重要。想想它是写下来,所以你不必以后再解释一下。
编码标准
如果您无法找出如何清理代码,或者如果您有与同事进行格式化的语义参数,则可能会有一些文档化的编码标准,具体取决于您使用的技术。例如,WordPress有HTML,PHP,CSS和Javascript的指南。完全整合或包含WordPress等技术的编码标准不仅可以清理您正在撰写的代码,还可以将其与社区的标准相一致 - 您可能会要求帮助,雇用或工作的社区。保存内容清洁和符合任何当前的编码标准可以帮助您了解彼此。
好处
如果您发现自己犯有上述任何草率的代码,我建议您使用上述建议作为清理代码的起点。这将需要一些努力和小的时间投入,但是在这样做的时候,你不仅会更加为自己的工作感到自豪,而且还会为自己和他人节省很多时间和头痛。对于更有用的信息,您可以参考“ 清洁代码:敏捷软件工具手册”进一步阅读。