对自己的代码负责

对自己的代码负责

写代码

  1. Make it
  2. Make it work
  3. Make it right
  4. Make it fast
  5. Make it best

让别人少一些谩骂

“谁写的烂代码?又来刁难小爷:P”

阅读代码时的谩骂量和代码的质量负相关。为了让别人阅读代码时少一些谩骂,请写可读性好的高质量代码,这个谩骂的人可能是两个星期后的自己。

像对待自己的脸一样对待自己的代码,获得一个好的名声。决不能让人有把柄说那家伙写的烂代码像一坨坨屎一样混杂在团队项目中。

易读易理解

让人易读易理解代码,Bug是最容易发现的,也是最容易一眼看出来不会有Bug的代码。

好代码 > 坏代码 + 好注释

"好代码 > 坏代码 + 好注释"这个标题是不应该存在的,坏代码不存在更好。

好的注释可以让好代码更佳,注释可以表达更多软件编程人写代码时的真实想法。

个人代码风格

个人服从团队的风格,让团队的代码保持同一种风格。

组合方法

较长的方法用组合方法进行拆分,次一点也要进行分段注释。

左变量,右常量

条件表达式中按照左变量,右常量的格式编写。

运算符左右留空格

运算符不要紧挨着变量,留一个空格更好。

相似和一致

相似的功能代码应该是相似的,最好能达到一致,提取为一个方法。

格式上应该顺序一致,对齐代码。

最简函数声明

用户只要传入最少的参数,不用考虑函数的具体实现。

有时候会遇到一些不太好用的接口,比如要传入多余的变量、调用的接口有副作用等。如能改接口最好,不能改就要进行适当的封装达到最简函数声明,不让烂代码蔓延。

自包含,减少依赖。

精确命名,添加注释

好的命名让程序读起来像自然语言一样流畅。好的名字无歧义又能精确表达内容。少使用非通用的缩写,那会让人花更多的时间理解你的代码,命名保持精准又不过长。

注释做到不冗余,又能表达更佳完整的含义。

代码签名

软件全局注释中写上自己的签名,包含姓名、时间、联系方式......

打赏