保持编程代码清洁的10条原则_极简慕枫

几乎所有能够让人们完全疯狂的职业的一个常见问题是不得不继续从其他人开始。造成这种情况的主要原因是每个人都有不同的工作方式，有时这些自我引发的习惯可能只是彻头彻尾的混乱。长沙企业网站建设

为了使代码看起来更清晰，从而支持团队工作（意味着其他人可能需要使用之前编码的代码），需要考虑一些注意事项。

保持编程代码清洁

1.在编码之前修改逻辑

在盲目地输入选择的调试器之前，一些流程图或编写的伪代码可能会派上用场，以便先验证这些代码行背后的逻辑。首先写下来可以澄清复杂功能的许多疑问或不安全因素，因此可以节省大量时间。但最重要的是，帮助您更快地完成它也将帮助您避免所有混乱的代码替换和添加篡改以下原则。

2.明确暴露页面结构

使用主容器很有用，但使用具有代表ID的主容器更有用。请考虑以下开始方案：

由于DIV容器具体以其目标内容命名，因此结构看起来很明显。开始添加代码不仅更简单，而且对于试图在之后添加或删除内容的人来说，它也是完全透明的。但是，这种结构化方法应该得到下一个声明的帮助。

3.使用正确的缩进

支持先前关于结构的声明，缩进明显地显示所使用的每个元素的开始和结束点。如果每行代码粘贴在屏幕的左侧，则很难区分元素关闭的确切位置。因此，它会破坏设计完整结构所付出的努力，因为之后不会引起注意。

4.写下解释性意见

低估好评论的价值是无视一种非常有效的代码文档方式。它既简单又快速，而且非常直观，因为它是在当时和那里需要的时候完成的。

考虑到可以在确切的时刻阅读它们这一事实，评论也是有效的。但是，它们可能被滥用。这将我们带到下一个建议。

5.避免滥用评论

评论不应轻描淡写。在对代码进行注释时，将根据变量和结果来解释当前功能。没有评论的是：

• 给自己写解释性说明（例如/ *稍后会完成...... * /）。

• 责备其他人（例如/ * John对此进行编码。问他。* /）。

• 编写含糊的陈述（例如/ *这是另一个数学函数。* /）。

• 擦除代码块。有时候人们不确定要删除的东西，而不是评论代码并不是绝对邪恶的。

什么是不对的就是事后离开它。这将非常令人困惑。如果代码将通过嵌入式注释进行记录，则团队成员需要确保这些注释是有原因的。

好用评论的例子有：

• 编写规范（例如/ *由John编写，2010年11月13日* /）。

• 关于方法或过程功能的详细说明（例如/ *此函数借助电子邮件检查功能验证登录表单* /）。

• 快速通知或标签，说明最近的更改（例如/ *添加了电子邮件验证程序* /）。

6.避免使用极大的功能

在向应用程序添加功能的过程中，其编码方法往往会相应增长。人们可以遇到由多达一百行代码组成的函数，这往往会让人感到困惑。

更好的做法是将大型功能分解为较小的功能。有些程序甚至可能在符合整个申请流程的其他功能中重复。团队可以通过单独的功能更好地利用这些重复的程序。但是，如果正确执行第一项建议，应该从一开始就避免这种情况。

7.使用函数和变量的命名标准

无论何时创建变量或函数，其名称应该足够描述，以便大致了解它的作用或用途。

有些公司有自己预先建立的命名标准 （例如，任何数字变量的前缀'int_'），但也有许多公司员工不遵守这些标准。懒惰使人们在未来的重新设计中工作时间翻倍，所以每个人都需要开始学习如何摆脱它。

8.谨慎对待变化

正确的更改设备总结了之前所说的许多内容，例如有意义的评论而不是中断缩进。然而，需要强调它。每当需要添加，删除或更改某些内容时，还应该意识到不干涉以前维护代码清洁和有序的努力。

这主要涉及：

• 保持正确的缩进（例如，插入IF子句时，其内容的缩进将被增加）。

• 评论修改或扩大现有评论。

• 尊重使用标准。

9.避免不加选择地混合编码语言

内嵌CSS样式和分散的JavaScript标记以及其中的短程序是在整个开发过程中错误混合编码语言的非常好的例子。忽略这个原则将导致巨大的元素标签具有嵌入的STYLE属性，由于嵌入式功能导致结构流中的大量中断，当然还有很多混乱。

即使添加了评论，它仍然看起来像一切，而不是同时。在不同的编码语言之间进行适当的划分将使所应用的逻辑有序。然而，这给我们带来了下一个考虑。

10.总结你的进口

尽管从不同文件导入其他编码语言要好得多，但这不应该被滥用。如果样式表太多，则可以将它们概括为一个或两个。

这不仅可以节省空间并使事物看起来更清洁，而且还可以节省加载时间。每个导入的文件都是一个HTTP请求，会篡改您的应用程序的性能。因此，除了考虑整洁之外，它还是效率的考虑因素。

当然，这样可以避免处理Internet Explorer对单个样式表数量的限制。

总结一下

什么方便并不总是对开发过程最有利，因为找到方便的做事往往会让我们无视编码效率。在这种情况下，为了提高效率，我们非常需要跟上标准，以便维护将来可读的代码。考虑到升级同一个应用程序并不总是同一个人，代码应该足够开放并且可以理解为真正支持团队工作。

长沙企业网站建设