如何避免自己写的代码成为别人眼中的一坨屎 (摘自微信公众号,顶级程序员)...-程序员宅基地

技术标签: git  测试  设计模式  

从微信公众号上读到一篇文章,记录下来提醒自己也分享给大家~

一、注释

  • 不要给不好的名字加注释,一个好的名字比好的注释更重要;

  • 不要“拐杖注释”,好代码 > 坏代码 + 好注释;

  • 在文件/类级别使用全局注释来解释所有部分如何工作;

  • 一定要给常量加注释;

  • 团队统一定义标记:

    • TODO  待处理的问题;

    • FIXME  已知有问题的代码;

    • HACK 不得不采用的粗糙的解决方案;

  • 在注释中用精心挑选的输入输出例子进行说明;

  • 注释应该声明代码的高层次意图,而非明显的细节;

  • 不要在代码中加入代码的著作信息,git可以干的事情不要交给代码;

  • 源代码中的html注释是一种厌物, 增加阅读难度;

  • 注释一定要描述离它最近的代码;

  • 注释一定要与代码对应;

  • 公共api需要添加注释,其它代码谨慎使用注释;

  • 典型的烂注释:

    • 不恰当的信息;

    • 废弃的注释;

    • 冗余注释;

    • 糟糕的注释;

    • 注释掉的代码;

  • 唯一真正好的注释是你想办法不去写的注释:

    • 不要有循规式注释,比如setter/getter注释;

    • 不要添加日志式注释,比如修改时间等信息(git可以做的事情);

    • 注释一定是表达代码之外的东西,代码可以包含的内容,注释中一定不要出现;

    • 如果有必要注释,请注释意图(why),而不要去注释实现(how),大家都会看代码;

    • 适当添加警示注释;

二、命名

  • 尽可能使用标准命名方法,比如设计模式,通用学术名词等;

  • 命名要找更有表现力的词:

    • 使用更专业的词,比如不用get而使用fetch或者download;

    • 避免空泛的名字,像tmp;

    • 使用具体的名字来细致的描述事物;

    • 给变量名带上重要的细节,比如加上单位ms等;

    • 为作用域大的名字采用更长的名字,作用域小的使用短名字;

    • 变量类型为布尔值表达加上is,has,can,should这样的词会更明确;

  • 变量名称长短应该与其作用域对应;

  • 别害怕长名称,长而具有描述性的名称比短而令人费解的名称好;

  • 函数名称应该说明副作用,名称应该表达函数,变量或类的一切信息,请不要掩盖副作用,比如CreateAndReturnXXX;

三、方法

  • 函数不应该有100行那么长,20行封顶最好:

    • if else while等控制语句其中代码块应该只有一行,也就是一个函数调用语句;

    • 函数的锁进层次不应该多于两层;

    • 一个函数只做一件事,一个函数不应该能抽象出另外一个函数;

  • 某个公共函数调用的私有函数紧随其后;

  • 最理想的参数是零参数,最长不要超过三个入参,尽量不要输出参数:

    • 如果函数传入三个及以上参数最好将其抽象为类;

    • 标识参数十分丑陋,向函数传入布尔值用于区分不同业务的做法很丑陋,应该拆分为多个函数;

  • 别返回null值,抛出异常或者返回特殊对象,尽量避免NPE;

  • 别传入null值;

四、异常与错误

  • 抽离try catch包含的代码块,其中代码块抽象为一个函数;

  • 抛出的每个异常,都应当提供足够的环境说明,已便判断错误的来源与处所;

  • 不要将系统错误归咎于偶然事件;

五、并发

  • 分离并发相关代码与其它代码;

  • 严格限制对可能被共享的数据的访问;

  • 避免使用一个共享对象的多个同步方法;

  • 保持同步区域微小,尽可能少设计临界区;

六、单元测试

  • 不要怕单元测试的方法名字太长或者繁琐,测试函数的名称就像注释;

  • 不要追求太高的测试覆盖率,测试代码前面90%通常比后面10%花的时间少;

  • 使用最简单的并且能够完整运用代码的测试输入;;

  • 给测试函数取一个完整性的描述性名字,比如  Test _;

  • 测试代码与生产代码一样重要;

  • 如果测试代码不能保证整洁,你就会很快失去他们;

  • 每个测试一个断言,单个测试中断言数量应该最小化也就是一个断言;

  • FIRST原则:

    • 快速 Fast;

    • 独立 Independent  测试应该相互独立;

    • 可重复 Repeatable  测试应当在任何环境中重复通过;

    • 自足验证 Self-Validating   测试应该有布尔值输出;

    • 及时  Timely   最好的方式是TDD;

七、代码结构

  • 代码行长度控制在100-120个字符;

  • 可能用大多数为200行,最长500行的单个文件构造出色的系统;

  • 关系密切的代码应该相互靠近:

    • 变量声明应该靠近其使用位置;

    • 若某个函数调用了另外一个,应该把他们放在一起,而且调用者应该放在被调用者上面;

    • 自上向下展示函数调用依赖顺序;

  • 应该把解释条件意图的函数抽离出来,尽可能将条件表达为肯定形式;

  • 不要继承常量,比如接口中定义常量,不要使用继承欺骗编程语言的作用范围规则;

  • 模块不应了解它所操作对象的内部情况;

  • DTO(Data Transfer Objects)是一个只有公共变量没有函数的类;

  • 对象暴露行为,隐藏数据;

  • 不要使用“尤达表示法” 如 if(null == obj),现代编译器对if(obj = null)这样的代码会给出警告;

  • 一般情况使用if else,简单语句使用三目运算符;

  • 通常来讲提早返回可以减少嵌套并让代码整洁;

八、设计

  • 类应该足够短小:

    • 类应该满足单一权责原则(SRP),类和模块只有一个修改理由;

    • 类应该只有少量的实体变量;

    • 类应该遵循依赖倒置原则 DIP(Dependency Inversion Principle),类应该依赖于抽象而不是依赖于具体细节;

    • 类中的方法越少越好,函数知道的变量越少越好,类拥有的实体变量越少越好;

  • 通过减少变量的数量和让他们尽量“轻量级”来让代码更有可读性:

    • 减少变量;

    • 缩小变量的作用域;

    • 只写一次的变量更好,如常量;

  • 最好读的代码就是没有代码:

    • 从项目中消除不必要的功能,不要过度设计;

    • 从新考虑需求,解决版本最简单的问题,只要能完成工作就行;

    • 经常性地通读标准库的整个API,保持对他们的熟悉程度;

  • 简单设计:

    • 运行所有测试;

    • 不可重复;

    • 表达了程序员的意图;

    • 尽可能减少类和方法的数量;

    • 以上规则按重要程度排列;

  • 无论是设计系统或者单独模块,别忘了使用大概可工作的最简单方案;

  • 整洁的代码只提供一种而非多种做一件事的途径,他只有尽量少的依赖。明确定义并提供尽量少的API;

  • 减少重复代码,提高表达力,提早构建,简单抽象;

 

转载于:https://www.cnblogs.com/Yida-Tingting/p/9395377.html

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_30828379/article/details/96872897

智能推荐

Android NDK开发——人脸检测与静默活体检测_安卓 人脸检测-程序员宅基地

文章浏览阅读1w次,点赞3次,收藏41次。安卓实现工业级静默活体检测,判别机器前出现的人脸是真实还是伪造。用于判别虚假人脸。_安卓 人脸检测

Java isDigit()-程序员宅基地

文章浏览阅读3.5k次,点赞4次,收藏20次。Java isDigit() 方法JAVA Character类1.用于判断指定字符是否是数字,返回boolean类型public static boolean isDigit(char ch)2.参数:字符3.测试:public class isDigit { /** * @param args */ public static void main(String[]..._java isdigit

Linux学习资料-基础正规表示法(grep)-程序员宅基地

文章浏览阅读79次。2019独角兽企业重金招聘Python工程师标准>>> ..._grep命令配合特殊符号进行各种查询。如:查找 /etc 底下只要含有 xyz 三个字符的任

Jena 解析 TTL格式文件-程序员宅基地

文章浏览阅读893次。import java.io.InputStream;import java.util.*;import org.apache.jena.rdf.model.Model;import org.apache.jena.rdf.model.ModelFactory;import org.apache.jena.rdf.model.RDFNode;import org.apa..._java 对 ttl文件进行解析

推荐系统中的双塔模型_双塔模型中的sigmoid-程序员宅基地

文章浏览阅读3.3k次,点赞5次,收藏43次。文章目录1. 为什么要学习DSSM双塔模型2. DSSM模型理论知识2.1 DSSM模型的原理2.2 DSSM深度语义匹配模型整体结构2.2.1 输入层2.2.2 表示层2.2.3 匹配层2.3 DSSM模型的优缺点3. 推荐领域中的DSSM双塔模型3.1 从NLP领域跨界到推荐领域的DSSM3.2 朴素的DSSM双塔模型,20153.3 百度的双塔模型3.4 谷歌的双塔模型,20194. 实战广告推荐的双塔模型4.1 广告推荐业务场景4.2 广告推荐的DSSM双塔模型结构4.2.1 输入层4.2.2 表示_双塔模型中的sigmoid

JavaWeb学习——Servlet学习(Cookie、Session)_用cookie和session是用sevlet还是java-程序员宅基地

文章浏览阅读204次。JavaWeb学习——Servlet学习(Cookie、Session)1.Cookie和Session简单理解问题引出:我想大家都有这种经历,当我们在网页上访问一个网页时,比如博客,邮箱等一些需要登陆的网站。每当我们关闭浏览器,下次再进入该网站时我们还需要再登陆(当然有些浏览器可能会做处理,询问用户是否保存用户名和密码,这个是属于浏览器帮我们做的,不做考虑)。但是当我们登陆上去但是不关闭浏览..._用cookie和session是用sevlet还是java

随便推点

【计算机组成原理】第三章 Cache主存地址映射专题及练习_四路组相联映射-程序员宅基地

文章浏览阅读1.3w次,点赞39次,收藏303次。这里写自定义目录标题0. Cache工作原理1. 直接映射优缺点计算方法2. 全相联映射优缺点3. 组相联映射例题1.2.3.0. Cache工作原理1. 直接映射下面针对该映射方式,举一个小例子:当缓存接收到CPU发送来的主存地址后,只需根据中间c位字段(假设为00…01)找到缓存块1,然后根据字块1的”标记”是否与主存地址的高t位相符合,若符合且有效位为1(这里的有效位用来识别Cache存储块中的额数据是否有效,因为有时Cache中的数据是无效的,例如,在初始时刻Cache中的额内容为空,是_四路组相联映射

【数学建模】MATLAB_matlab的setvar-程序员宅基地

文章浏览阅读1.8k次,点赞2次,收藏15次。MATLAB一、基本介绍二级目录三级目录二、矩阵运算三、编程基础(1)四、编程基础(2)五、常见函数六、二维图形绘制七、三维图形绘制八、运算符九、流程控制语句十、其他常用函数十一、自定义函数十二、画图进阶一、基本介绍二级目录三级目录二、矩阵运算三、编程基础(1)四、编程基础(2)五、常见函数六、二维图形绘制七、三维图形绘制八、运算符九、流程控制语句十、其他常用函数十一、自定义函数十二、画图进阶..._matlab的setvar

VS2022 无法启动程序 不是有效的win32程序_vs不是有效的win32应用程序怎么解决-程序员宅基地

文章浏览阅读2.9k次,点赞3次,收藏7次。VS2022 无法启动程序 不是有效的win32程序_vs不是有效的win32应用程序怎么解决

Unix/Linux/BSD 它们之间的关系以及各自派系的介绍_linux bsd简单描述-程序员宅基地

文章浏览阅读4k次,点赞11次,收藏30次。Unix 是什么电话发明人贝尔于 1877 年创建的美国贝尔电话公司,后来创建了一家子公司叫美国电信业公司,1900年美国电信业公司接管了贝尔公司的全部资产,成为母公司,改名为美国电话电报公司(AT&T),美国电话电报公司有个部门叫贝尔实验室,以肯•汤普森为首的贝尔实验室研究人员于 1969 年实现了一种分时操作系统的雏形,1970 年该系统正式取名为 UNIX。而肯•汤普森的同事丹尼斯•里奇发明了传说中的 C 语言,这是一种适合编写系统软件的高级语言,后来 UNIX 系统的绝大部分源代码都用 C_linux bsd简单描述

贝叶斯网络:Netica的使用记录_netica 逆向推理-程序员宅基地

文章浏览阅读1.3w次,点赞2次,收藏27次。1. 节点的Name与Title区别。name是根据IDname的命名规则,只能用字母开头,随后跟数组、下划线。不能出现空格或者发音。Title突破了这一限制。系统首选Title,如果没有,用name作为节点名字。2. 节点的Status Value与 Table Value的区别。Status对应着状态的名字,可以是单词,Status Value表示状态对应的值。例如爆炸控制系统中“off”状态_netica 逆向推理

【GRU回归预测】基于麻雀算法优化空间注意力机制卷积神经网络结合门控循环单元SSA-CNN-GRU-SAM-Attention实现数据多维输入单输出预测附matlab代码-程序员宅基地

文章浏览阅读799次,点赞18次,收藏18次。本文提出了一种基于麻雀算法优化空间注意力机制卷积神经网络结合门控循环单元SSA-CNN-GRU-SAM-Attention的回归预测模型,用于解决数据多维输入单输出预测问题。该模型将麻雀算法与空间注意力机制卷积神经网络相结合,并加入门控循环单元GRU,以提高模型的预测精度和泛化能力。同时,该模型还采用了SAM注意力机制,进一步增强了模型对重要特征的提取能力。实验结果表明,该模型在多个数据集上取得了良好的预测性能,优于传统回归预测模型。

推荐文章

热门文章

相关标签