江苏龙网

  1. 首页 > 人文 > >

优秀软件设计的基本元素是什么？( 二 )


为什么我讨厌代码中的注释当您需要注释代码时 ， 它基本上很烂 。当您需要解释为什么要执行某项操作时 ， 该代码并不是不言自明的 ， 因此无论如何都应该对其进行重构 。代码注释清楚地表明了错误代码 ， 并且可以采取许多简单的步骤使代码更具可读性 。
注释不能弥补混乱的代码 。当代码令人困惑或做出危险的假设时 ， 我们倾向于写一些额外的注释 。
唯一有意义的注释是：
· 法律评论
· 目的说明
· 提高可读性
· 警告后果
· 待办事项
如何编写更好的代码有许多简单的原则可以帮助您编写更轻松的代码 ， 而您的同事会喜欢并喜欢与他们一起工作 。对于其中的每一个 ， 都可以编写一个完全独立的文章 ， 因此 ， 这里有一个简单的清单 ， 可以开始您迈向更好的代码 。
类类应该很小 。多么小？ 尽可能小 。一个类应该只承担一个责任 ， 并且其名称应从该责任派生 。如果您无法想到一个具有逻辑性和描述性的类名 ， 则它可能太大 。
方法/功能像类一样 ， 它们应该很小 ， 只做一件事 ， 并具有解释性和简单的名称 。注意标识 。许多缩进通常是一种凌乱方法的迹象 。对于Foreach和switch语句 ， 请确保将实际执行的代码编写在单独的函数中 ， 这使其更像是该方法针对不同实现实际执行的操作的索引 。
有意义的名字类 ， 函数和变量都应具有有意义的名称 。例如 ， 切勿使用$ a = b; 。让您的代码成为功能和意图的文档 。
格式和代码样式确保您的整个应用程序和整个团队使用完全相同的代码样式 ， 并且对此非常严格 。每种IDE和语言都有用于此目的的工具 。一致的空格或换行符可以起到很大作用 。如果不一致 ， 则会使您发疯 。在这方面非常严格将立即提高应用程序的整洁度 ， 尤其是在这方面不是很严格的语言中 。
(本文翻译自kay in t veen的文章《What Are the Fundamentals of Good Software Design?》 ， 参考：)


推荐阅读


上一篇：iPad是否可以取代纸质笔记本？

下一篇：vivo S7对比华为nova 7 Pro，谁更胜一筹？