![](https://img-blog.csdnimg.cn/20201014180756925.png?x-oss-process=image/resize,m_fixed,h_64,w_64)
代码整洁之道
烟草的香味.
这个作者很懒,什么都没留下…
展开
-
代码整洁之道小结
以下总结一些不好的代码规范, 借此警示自己不要犯这种错误 注释 1.不恰当的注释 注释应该仅用来描述有关代码和设计的技术性信息。像修改历史等信息不应出现在注释中 2.废弃的注释 过时、无关或错误的注释就是废弃的注释,不要写这种注释,如果发现了请尽快更新或删除,否则它会越来越远离它开始描述的代码 3.多余的注释 如果代码自身就能说明,就不要去写注释,例如: i++; // i自增 注释应该说明代码...原创 2019-10-20 19:48:59 · 98 阅读 · 0 评论 -
代码整洁之道-函数
什么是一个好的函数或者叫方法,只要能让函数明确的表达其意图,让读者能够一眼看出是一个怎样的函数,其接收什么参数,返回什么结果,做了什么事情。能做到这,大概就能算作一个好的函数了,看上去很简单。那么问题来了,如果做到这点呢? 1. 短小 想象一下,一个击败航的复杂函数和一个只有十几行的函数,哪一个能够让人一眼看出其意图并理解其行为呢?显然是后者。当然,现在大多数语言完全可以将几百行代码写到一行,...原创 2019-09-22 18:28:28 · 142 阅读 · 0 评论 -
代码整洁之道-格式
对于代码的格式,每个人都有不同的代码风格,这没什么。但是对于一个团队来说,最好能够统一代码风格,在同一个项目中,如果到处充斥着不同的代码风格,相比读起来并不是那么让人舒适,比如在什么地方放置括号,缩进几个字符,如何命名常量、变量和方法等,整个团队都应该遵循同一套规则,甚至可以将这些规则编写到IDE的代码格式中,利用IDE的提示功能来帮助。 刚才说的风格随不同,但是并不会影响读者阅读。但是有些代码...原创 2019-09-22 18:44:46 · 138 阅读 · 0 评论 -
代码整洁之道-对象和数据结构
现在,有一个计算面积的需求,其中一种实现如下: class Square{ public $side; } class Geometry{ public function area($shape){ if($shape instanceof Square){ return $shape->side * $shape->side; ...原创 2019-09-22 19:06:42 · 61 阅读 · 0 评论 -
代码整洁之道-类
在面向对象的编程中,类是其中的基本单位,就像面向过程中的函数一样。所以在说类时,可以借鉴一下前面的函数,不如只做一件事,也就是所说的单一职责。 函数应该短小,对于类来说,也是这样。函数的短小可以通过代码行数来判断,对于类来说,如何判断呢?可以通过判断其职责,也就是看它是否只做一件事情。同时做多件事情的类,命名也是一件痛苦的事情。比如一个类名叫 Manneger,很容易让人误解,它管理什么呢? 所以...原创 2019-09-22 19:20:13 · 169 阅读 · 0 评论