idea编写代码提示报错
在这篇简短而又有用的文章中,我总结了编写干净代码的最有益的技巧。 这些规则与您使用的语言无关,并且对于初学者和经验丰富的程序员而言都是无价的。
马丁·戈尔丁(Martin Golding)的名言是:
“总是编码,好像最终维护您的代码的那个人将是一个暴力的精神病患者,知道您的住所。”
编写干净的代码可使代码更容易理解,并且对于创建成功的可维护产品至关重要。
程序员是作者,您的目标受众不是计算机; 是其他程序员(和您自己)。
任何傻瓜都可以编写计算机可以理解的代码。 优秀的程序员编写人类可以理解的代码。”-Martin Fowler。
为了能够编写简洁的代码,您应该花一些时间来训练自己的思维。 最难的部分只是开始,但是随着时间的流逝和您的技能的提高,它变得更加容易。 编写干净的代码完全是为了提高可读性,因此,即使是最小的事情(如更改变量命名习惯)也会产生最大的不同。
根据罗伯特·C·马丁(Robert C. Martin)所著的《 干净的代码 :敏捷软件技巧手册》,该团队的每个人都可以轻松理解代码,这是干净的。 可理解性伴随着可读性,可变性,可扩展性和可维护性。
编写干净代码的一般规则
- 遵循标准约定。
- 简单总是更好。 尽可能降低复杂性。
- 始终找到根本原因。 始终寻找问题的根本原因。
- 始终如一。 如果您以某种方式做某事,请以相同的方式做所有类似的事情。
- 使用解释变量。
- 优先使用专用值对象而不是原始类型。
- 避免逻辑依赖性。 不要编写依赖于同一类中其他内容的正确工作的方法。
- 避免负面条件。
名字
使用意图揭示名称。 选择专有名称需要花费时间,但可以节省更多的时间。 变量,函数或类的名称应回答所有大问题。 它应该告诉您它为什么存在,它做什么以及如何使用。 如果名称需要注释,则该名称不会显示其意图。
名称基本规则:
- 选择描述性的名称。
- 做出有意义的区分。
- 使用明显的名称。
- 使用可搜索的名称。
功能
功能的第一个规则是它们应该很小。 功能的第二个规则是它们应该小于该值。 这意味着if语句,else语句和while语句内的块应为一行。 该行可能是函数调用。 这不仅使封闭函数保持较小状态,而且还增加了文档价值,因为在块中调用的函数可以具有很好的描述性名称。
功能基本规则:
- 小。
- 做一件事。
- 使用描述性名称。
- 首选更少的参数(最多三个)。
- 没有副作用(函数只能执行名称所建议的操作,而不能做其他事情)。
- 不要使用标志参数。 将方法拆分为几个独立的方法,这些方法可以在不带标志的情况下从客户端调用。
注释。
理想情况下,根本不需要评论。 如果您的代码需要注释,则说明您做错了。 我们的代码应该解释一切。 现代编程语言是英语,通过它我们可以轻松地证明自己的观点。 正确的命名可以防止发表评论。
评论基本规则:
- 用作意图的解释。
- 用作代码说明。
- 用作后果警告。
- 总是尝试用代码解释自己。
- 不要多余。
- 不要使用大括号结尾的注释。
- 不要注释掉代码。 只是删除。
对象和数据结构。
对象将其数据隐藏在抽象之后,并公开对该数据进行操作的函数。 数据结构表示其数据,没有任何有意义的功能。
对象和数据结构的基本规则:
- 隐藏内部结构。
- 首选数据结构。
- 避免使用混合结构(一半对象和一半数据)。
- 少数实例变量。
- 基类对它们的派生词一无所知。
- 具有许多功能比将一些代码传递给功能来选择行为要好。
- 与静态方法相比,首选非静态方法。
可能无法立即在您的日常代码中应用所有这些规则。 但是结果是,它将为您的工作带来极大的满足感,并为将阅读您编写的清晰代码的人们带来真诚的感谢。
最好的书如何编写干净的代码:
拥有快乐的清洁密码!
此致Dmytro Pogribnyy。
翻译自: https://hackernoon.com/helpful-tips-for-writing-clean-code-ttot3ygn
idea编写代码提示报错