搜索内容：
时间：2019-08-01
编辑:网站制作公司
873
0
帮助我们将优秀程序员与优秀程序员分开的最大因素之一是他们编写干净代码的能力。那么编写干净的代码意味着什么呢？可读，可维护，通过文档得到良好支持的代码，使团队可以轻松扩展产品，代码编写得很好。让我们深入了解这些主题的更多细节。
可读代码就是它听起来的可读性。熟悉编程语言的人 - 或者一般的软件开发 - 应该能够浏览代码并轻松理解代码的实现。确保这一点的几种方法是：
总是编码好像最终维护你的代码的人将是一个暴力的精神病患者谁知道你住在哪里 - 约翰伍兹
现在推文
格式化：代码应格式良好，以便人们可以轻松地以一口大小的形式消化每行代码。就像读书一样，长期的决定经常让我们感到困惑并要求我们重新阅读它，类似地，复杂的代码往往最终会让所有人感到困惑，除了编写它的人（有时甚至是写作的人会回到它而不知道他们写的是什么）。强烈建议像Prettier这样的IDE插件来协助完成此任务。
注释：执行复杂功能或考虑新人可能不知道的假设的代码块应该在代码本身中记录注释。不需要对基本代码和自己说话的代码进行评论，但在编写代码本身之前以伪代码的形式编写注释通常是一种好的做法，然后只需填写语法来完成在代码中写下的逻辑。评论。这是一个很好的习惯，可以帮助你编写干净的代码。
清晰的命名约定：这是清洁代码的一个非常重要的方面，也是很多开发人员经常遇到的问题。确保您的方法，变量和其他自定义定义的名称具有描述性且易于理解，这不仅对于将与您的代码进行交互的人员非常有益，而且甚至是作为代码的作者，因为它将使代码阅读更像英语。程序员通常急于为变量或函数选择任何名称，然后继续快速编写代码。我们建议你坐下来思考一下这个名字，并考虑它的所有交互点，以及那些读得好。
一致性：基于前一点，良好命名约定的很大一部分是与它一致。格式化不仅要符合该语言定义的最佳实践（即Kebab案例，Camel案例等），而且使用的前缀和后缀也应遵循惯例。例如，在React中，当定义在UI中单击按钮时调用的方法时，该方法通常应以“handle”开头 - 因此，如果在表单中单击了提交按钮，则调用的方法发生的事情将被称为'handleSubmit'。很简单，但如果在整个代码库中没有始终遵循约定，它就会失去它的力量。
通过跨平台兼容性，Web应用程序仍然是产品的终极媒介。告诉我们您的项目是否有免费咨询。
广州高端网站建设
编写高度可读的代码是朝着正确方向迈出的一大步。然而，在较大的产品中，只有在事情开始变得非常复杂和混乱之前，它才能让你到目前为止。为了管理具有多个移动部件的大型产品，创建支持文档非常重要。以下是我们在Cygnis Media上严重依赖的一些内容。
最好的文档是自我记录代码和直观的用户界面。
现在推文
API文档：在构建服务时，可以安全地假设产品的几个不同区域将与它们进行交互（Web，iOS，Android等），而其他软件工程师需要知道如何与您拥有的服务进行交互构建，不想深入研究代码。这就是API文档的用武之地。它们记录了API调用所期望的参数或参数，它将需要哪些键，标记或其他重要的身份验证信息，以及输出应该是什么样的。还有很多内容，但这些是一些基础知识。这允许想要利用API的工程师能够使用所有正确的参数来调用它，而无需查看代码。
数据结构：数据结构图或实体关系图（取决于您使用的数据库类型）在构建产品体系结构并确保从资源效率角度进行优化时至关重要。能够从鸟瞰图中查看不同的表格，文档及其关系对于建筑师能够确保系统构建良好至关重要。
流程图：当需要使用逻辑可以拆分的多个分支构建复杂算法时，流程图很常见。例如，如果要为Slack构建通知系统，则在向用户发送通知时需要考虑很多事项，例如：用户是否已打开请勿打扰模式，让用户静音通道等。为了确保没有错过任何一个场景，并且能够清楚地解释/理解算法可以使用的所有不同路径为实现其最终目标，流程图非常有用。
拥有干净，记录良好的代码的最大优点是，它使您能够长时间维护代码。想象一下今天正在建造的产品，需要在未来10年内得到支持。在代码库上工作时来来往往的人数将会非常庞大，所有这些人都将被登上，对此前完成的工作知之甚少。我们应该总是编写代码并使用简洁的文档来支持它，这个代码有一天会被那些在编写代码时没有预先设想的知识的人阅读，我们的目标应该是他们仍然能够理解所有这一切。
要在之前的声明中加倍，如果产品的保质期为10年，那么肯定需要进行扩展才能获得成功。对于要扩展的产品，其团队通常也需要扩展。为了帮助实现这两方面的目标，现有产品的代码库和支持文档需要非常强大，以便新工程师和设计师加入产品团队并继续建立在他们面前的基础上。如果他们能够理解正在发生的事情，他们将只具备这种能力。干净，记录完整，可维护的代码将在很大程度上实现这一目标。
广州高端网站建设
3
s后返回登录
3
s后返回登录
