精华内容
下载资源
问答
  • 代码整洁 vs 代码肮脏

    万次阅读 多人点赞 2019-09-16 12:05:12
    整洁的代码,是每个程序员的追求。《clean code》指出,要想写好的代码,首先得知道什么是肮脏代码、什么是整洁代码;然后通过大量的刻意练习,才能真正写整洁的代码。 WTF/min是衡量代码质量的唯一标准,...

    写出整洁的代码,是每个程序员的追求。《clean code》指出,要想写出好的代码,首先得知道什么是肮脏代码、什么是整洁代码;然后通过大量的刻意练习,才能真正写出整洁的代码。

    WTF/min是衡量代码质量的唯一标准,Uncle Bob在书中称糟糕的代码为沼泽(wading),这只突出了我们是糟糕代码的受害者。国内有一个更适合的词汇:屎山,虽然不是很文雅但是更加客观,程序员既是受害者也是加害者。

    对于什么是整洁的代码,书中给出了大师们的总结:

    • Bjarne Stroustrup:优雅且高效;直截了当;减少依赖;只做好一件事
    • Grady booch:简单直接
    • Dave thomas:可读,可维护,单元测试
    • Ron Jeffries:不要重复、单一职责,表达力(Expressiveness)

    其中,我最喜欢的是表达力(Expressiveness)这个描述,这个词似乎道出了好代码的真谛:用简单直接的方式描绘出代码的功能,不多也不少。

    本文记录阅读《clean code》之后个人“深有同感”或者“醍醐灌顶”的一些观点。

    一、命名的艺术

    坦白的说,命名是一件困难的事情,要想出一个恰到好处的命名需要一番功夫,尤其我们的母语还不是编程语言所通用的英语。不过这一切都是值得了,好的命名让你的代码更直观,更有表达力。

    好的命名应该有下面的特征:

    1.1 名副其实

    好的变量名告诉你:是什么东西,为什么存在,该怎么使用

    如果需要通过注释来解释变量,那么就先得不那么名副其实了。

    下面是书中的一个示例代码,展示了命名对代码质量的提升

    # bad code
    def getItem(theList):
       ret = []
       for x in theList:
          if x[0] == 4:
             ret.append(x)
       return ret
    
    # good code
    def getFlaggedCell(gameBoard):
       '''扫雷游戏,flagged: 翻转'''
       flaggedCells = []
       for cell in gameBoard:
          if cell.IsFlagged():
             flaggedCells.append(cell)
       return flaggedCells
    

    1.2 避免误导

    • 不要挂羊头卖狗肉
    • 不要覆盖惯用缩略语

    这里不得不吐槽前两天才看到的一份代码,居然使用了 l 作为变量名;而且,user居然是一个list(单复数都没学好!!)

    1.3 有意义的区分

    代码是写给机器执行,也是给人阅读的,所以概念一定要有区分度。

    # bad
    def copy(a_list, b_list):
        pass
    
    # good
    def copy(source, destination):
        pass
    

    1.4 使用读的出来的单词

    如果名称读不出来,那么讨论的时候就会像个傻鸟

    1.5 使用方便搜索的命名

    名字长短应与其作用域大小相对应

    1.6 避免思维映射

    比如在代码中写一个temp,那么读者就得每次看到这个单词的时候翻译成其真正的意义

    二、注释

    有表达力的代码是无需注释的:The proper use of comments is to compensate for our failure to express ourself in code.

    注释的适当作用在于弥补我们用代码表达意图时遇到的失败,这听起来让人沮丧,但事实确实如此。The truth is in the code, 注释只是二手信息,二者的不同步或者不等价是注释的最大问题。

    书中给出了一个非常形象的例子来展示:用代码来阐述,而非注释

    bad
    // check to see if the employee is eligible for full benefit
    if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))
    
    good
    if (employee.isEligibleForFullBenefits())
    

    因此,当想要添加注释的时候,可以想想是否可以通过修改命名,或者修改函数(代码)的抽象层级来展示代码的意图。

    当然,也不能因噎废食,书中指出了以下一些情况属于好的注释

    • 法务信息
    • 对意图的注释,为什么要这么做
    • 警示
    • TODO注释
    • 放大看似不合理之物的重要性

    其中个人最赞同的是第2点和第5点,做什么很容易通过命名表达,但为什么要这么做则并不直观,特别涉及到专业知识、算法的时候。另外,有些第一感觉“不那么优雅”的代码,也许有其特殊愿意,那么这样的代码就应该加上注释,说明为什么要这样,比如为了提升关键路径的性能,可能会牺牲部分代码的可读性。

    最坏的注释就是过时或者错误的注释,这对于代码的维护者(也许就是几个月后的自己)是巨大的伤害,可惜除了code review,并没有简单易行的方法来保证代码与注释的同步。

    三、函数

    3.1 函数的单一职责

    一个函数应该只做一件事,这件事应该能通过函数名就能清晰的展示。判断方法很简单:看看函数是否还能再拆出一个函数。

    函数要么做什么do_sth, 要么查询什么query_sth。最恶心的就是函数名表示只会query_sth, 但事实上却会do_sth, 这使得函数产生了副作用。比如书中的例子

    public class UserValidator {
        private Cryptographer cryptographer;
        public boolean checkPassword(String userName, String password) {
            User user = UserGateway.findByName(userName);
            if (user != User.NULL) {
                String codedPhrase = user.getPhraseEncodedByPassword();
                String phrase = cryptographer.decrypt(codedPhrase, password);
                if ("Valid Password".equals(phrase)) {
                    Session.initialize();
                    return true;
                }
            }
            return false;
        }
    }
    

    3.2 函数的抽象层级

    每个函数一个抽象层次,函数中的语句都要在同一个抽象层级,不同的抽象层级不能放在一起。比如我们想把大象放进冰箱,应该是这个样子的:

    def pushElephantIntoRefrige():
        openRefrige()
        pushElephant()
        closeRefrige()
    

    函数里面的三句代码在同一个层级(高度)描述了要完成把大象放进冰箱这件事顺序相关的三个步骤。显然,pushElephant这个步骤又可能包含很多子步骤,但是在pushElephantIntoRefrige这个层级,是无需知道太多细节的。

    当我们想通过阅读代码的方式来了解一个新的项目时,一般都是采取广度优先的策略,自上而下的阅读代码,先了解整体结构,然后再深入感兴趣的细节。如果没有对实现细节进行良好的抽象(并凝练出一个名副其实的函数),那么阅读者就容易迷失在细节的汪洋里。

    某种程度看来,这个跟金字塔原理也很像
    file

    每一个层级都是为了论证其上一层级的观点,同时也需要下一层级的支持;同一层级之间的多个论点又需要以某种逻辑关系排序。pushElephantIntoRefrige就是中心论点,需要多个子步骤的支持,同时这些子步骤之间也有逻辑先后顺序。

    3.3 函数参数

    函数的参数越多,组合出的输入情况就愈多,需要的测试用例也就越多,也就越容易出问题。

    输出参数相比返回值难以理解,这点深有同感,输出参数实在是很不直观。从函数调用者的角度,一眼就能看出返回值,而很难识别输出参数。输出参数通常逼迫调用者去检查函数签名,这个实在不友好。

    向函数传入Boolean(书中称之为 Flag Argument)通常不是好主意。尤其是传入True or False后的行为并不是一件事情的两面,而是两件不同的事情时。这很明显违背了函数的单一职责约束,解决办法很简单,那就是用两个函数。

    3.4 Dont repear yourself

    在函数这个层级,是最容易、最直观实现复用的,很多IDE也难帮助我们讲一段代码重构出一个函数。

    不过在实践中,也会出现这样一种情况:一段代码在多个方法中都有使用,但是又不完全一样,如果抽象成一个通用函数,那么就需要加参数、加if else区别。这样就有点尴尬,貌似可以重构,但又不是很完美。

    造成上述问题的某种情况是因为,这段代码也违背了单一职责原则,做了不只一件事情,这才导致不好复用,解决办法是进行方法的细分,才能更好复用。也可以考虑template method来处理差异的部分。

    四、测试

    非常惭愧的是,在我经历的项目中,测试(尤其是单元测试)一直都没有得到足够的重视,也没有试行过TDD。正因为缺失,才更感良好测试的珍贵。

    我们常说,好的代码需要有可读性、可维护性、可扩展性,好的代码、架构需要不停的重构、迭代,但自动化测试是保证这一切的基础,没有高覆盖率的、自动化的单元测试、回归测试,谁都不敢去修改代码,只能任其腐烂。

    即使针对核心模块写了单元测试,一般也很随意,认为这只是测试代码,配不上生产代码的地位,以为只要能跑通就行了。这就导致测试代码的可读性、可维护性非常差,然后导致测试代码很难跟随生产代码一起更新、演化,最后导致测试代码失效。所以说,脏测试 - 等同于 - 没测试。

    因此,测试代码的三要素:可读性,可读性,可读性。

    对于测试的原则、准则如下:

    • You are not allowed to write any production code unless it is to make a failing unit test pass. 没有测试之前不要写任何功能代码
    • You are not allowed to write any more of a unit test than is sufficient to fail; and compilation failures are failures. 只编写恰好能够体现一个失败情况的测试代码
    • You are not allowed to write any more production code than is sufficient to pass the one failing unit test. 只编写恰好能通过测试的功能代码

    测试的FIRST准则:

    • 快速(Fast)测试应该够快,尽量自动化。
    • 独立(Independent) 测试应该应该独立。不要相互依赖
    • 可重复(Repeatable) 测试应该在任何环境上都能重复通过。
    • 自我验证(Self-Validating) 测试应该有bool输出。不要通过查看日志这种低效率方式来判断测试是否通过
    • 及时(Timely) 测试应该及时编写,在其对应的生产代码之前编写

    该文章通过 https://openwrite.cn/ 工具创造并群发。

    展开全文
  • 解决IDEA代码重叠问题

    万次阅读 2021-03-26 20:17:58
    1 问题描述 IDEA默认情况下会出现代码重叠,如下图所示: 2 解决方法 快捷键:ctrl+shift+s,弹设置面板 直接搜索code folding 点击General下面的Code Folding选项,再在右侧取消one-line methods前面的对勾 ...

    1 解决方法代码重叠

    IDEA默认情况下会出现代码重叠,如下图所示:
    在这里插入图片描述
    解决方法:

    1. 快捷键:ctrl+alt+s,弹出设置面板
    2. 直接搜索code folding
    3. 点击General下面的Code Folding选项,再在右侧取消one-line methods前面的对勾
    4. 依次点击右下角的Apply和OK
      在这里插入图片描述

    2 解决导包代码重叠

    按下图操作即可:
    在这里插入图片描述


    结束语:如果本篇博客对您有帮助,请点赞、关注或收藏,您的鼓励是博主进步的动力,感谢支持,共同进步。

    展开全文
  • 最近在idea使用git提交代码的时候,更新之后发现自己的代码还没提交就已经没了 不知道是不是自己git命令使用有问题,反正做个记录吧 右击项目,选择 “Local History” —> “Show History” ,弹一个框,...

    最近在idea使用git提交代码的时候,更新之后发现自己的代码还没提交就已经没了
    不知道是不是自己git命令使用有问题,反正做个记录吧

    右击项目,选择 “Local History” —> “Show History” ,弹出一个框,左侧是你的修改历史,右侧是对应修改的内容,选中需要恢复的历史版本和文件,点击上方的Revert Selection 按钮或者右击要恢复的文件或者文件夹选择Revert Selection即可。

    展开全文
  • 大家知道的是很多电脑装软件需要管理员权限,如何获得管理员权限呢,需要本地策略里面的安全策略修改管理员权限,但百度了各种组策略都不行,要么是系统的问题,要么干脆不好用,本人总结了用代码搞定的问题,方法...

    大家知道的是很多电脑装软件需要管理员权限,如何获得管理员权限呢,需要本地策略里面的安全策略修改管理员权限,但百度了各种组策略都不行,要么是系统的问题,要么干脆不好用,本人总结了用代码搞定的问题,方法如下:

    首先我的电脑很卡,也没有管理员权限装软件,需要管理员权限优化啊,然后在优化的过程中,突然发现我的gpedit.msc组策略找不到了!弹出报错!

    百度改环境变量也不好使

    最后google到处找,看到了这个,一行代码就解决了问题。

    @echo off

    pushd "%~dp0"dir /b C:\Windows\servicing\Packages\Microsoft-Windows-GroupPolicy-ClientExtensions-Package~3*.mum >List.txtdir /b C:\Windows\servicing\Packages\Microsoft-Windows-GroupPolicy-ClientTools-Package~3*.mum >>List.txtfor /f %%i in ('findstr /i . List.txt 2^>nul') do dism /online /norestart /add-package:"C:\Windows\servicing\Packages\%%i"pause

    首先在你的桌面新建一个.txt的文本,把代码复制粘贴到文本内,再保存关闭,重命名这个新建文本文档,修改其后缀.txt变成.cmd后缀就行。

    如下图所示,注意格式,格式,格式!

     

    展开全文
  • 14个提高代码质量的好问题

    万次阅读 多人点赞 2020-04-17 08:07:51
    阅读本文大概需要 2.6 分钟。并不是代码写的越多,代码的质量就越高。思考才是。解决一个问题,打开电脑就手撕代码,最终的结果往往是各种代码问题,经过一系列迭代后,代码积重难返,最终的结果...
  • 自己写不出代码我该怎么办

    千次阅读 多人点赞 2011-12-07 20:27:15
    在作业和练习中,自己写不出代码,这是一个在学习中经常出现的问题, 那么该怎么解决这个问题呢?   1:先分析实现的思路  拿到作业,按照要实现的功能,先分析去实现的思路。    如果完全不知到该怎么去...
  • 最近遇到了一个奇葩的问题,在项目开发中,一些同事的idea突然就编译不过去了,点击【RUN】会报下面的错误:org.springframework.beans.factory.support.DefaultListableBeanFactory -->Bean creation exception ...
  • 但是作为一个备忘吧,也供其它有类似问题的参考。 故障现象 惠而浦滚筒洗衣机,带烘干功能。洗了比较多的衣物 到了甩干时滚筒转不起来,面板显示E12故障代码 起初以为是洗的衣服太多了,重心无法平衡,这种现象...
  • 微信搜索:“二十同学” 公众号,欢迎关注一条不一样的成长之路 在...7.任意打开一个文件,便可以实时看到检测问题,在SonarLint On-The-Fly中可以看到检测出来的问题,在SonarLint Rule Description中可以看到修改建议
  • 问题主要是git仓库上的代码和本地代码存在冲突。 解决办法:1、新建一个文件夹重新从git拉取最新的代码,使用beyond compare对比合并自己修改的代码到新拉的代码里,提交 2、放弃本地修改,直接覆盖 git reset --...
  • 程序员写这样的代码,能不挨骂吗?

    万次阅读 多人点赞 2020-03-13 17:04:21
    当你换槽填坑时,面对一个新的环境。能够快速熟练,上手实现业务需求是关键。但是,哪些因素会影响你快速上手呢?是原有代码写的不够好?还是注释写的不够好?昨夜...
  • 从图中描述可以知道,问题出在rt.jar文件没有源附件,需要我们添加source attachment才能查看。 解决方法 src.zip文件:Java所有类的source attachment,我们只要把它添加到rt.jar文件中就可以解决我们的...
  • 使用SVN客户端导入和检出代码

    万次阅读 2016-07-20 23:28:37
    今天项目改了服务器,以前使用的url没有用了,需要换一个url,可是当前的项目已经设置成了之前的网址,,现在怎么办呢,我查了下没找到,,我们的经理人还是蛮好的,他是这样教我的, 第一步:把原来的svn连接去掉 ...
  • 错误信息 ... 情景 本地编译,本地调式,完全没有问题,发布至原服务器上也没有问题,但是,在发布至新的...首先根据其给的错误代码0x8007000d去查找原因。参照的是其给的错误代码参考: https://support.microsoft...
  • 问题描述:我使用的是Ubuntu16.04版本的Linux系统,安装VSCode浏览和ROS系统相关的代码,最近突然出现在IDE中跳转不到函数定义的地方。重新安装VSCode也没有解决该问题。。。 问题原因:Visual Studio Code ...
  • 异常抛代码还会继续执行吗?

    万次阅读 2018-09-29 11:39:17
    今天遇到一个问题,在下面的代码中,当抛运行时异常后,后面的代码还会执行吗,是否需要在异常后面加上return语句呢? public void add(int index, E element){ if(size >= elements.length) { throw ...
  • java抛异常后代码继续执行的情况

    万次阅读 2017-08-08 18:17:42
    java抛异常后代码继续执行的情况java抛异常后下面的代码是否还会执行?例如下面情况public void add(int index, E element){ if(size >= elements.length) { throw new RuntimeException("顺序表已满...
  • 今天在项目中遇到了一个问题,就是在java中抛异常后,后面的代码是否能继续执? 然后就写了几个Test案例测试了一下: 1.Test1 Test1的结果: 由Test1的结果可以知道:throw new RuntimeException(...
  • 再安装SharpDevelop时遇到该问题。 主要是权限不够,C:\Windows\temp先访问权限 找到该目录,选择temp文件夹,右键弹快捷菜单,选择“管理员取得所有权”。确定,OK。 再安装软件OK。
  • 不敢再喝了,因为搞不好要有副作用了,心跳加速,身体不由自主地颤抖,冷汗,但还是无法产出任何代码。 所有重新发现编程趣味的努力都徒劳无功,因为你的最后一点能量都用来驱逐大脑中正在攻城略地的话: ...
  • 今天遇到一个问题,在下面的代码中,当抛运行时异常后,后面的代码还会执行吗,是否需要在异常后面加上return语句呢? @Override public void registerObserver(Observer o) { if (o == null){ throw new ...
  • 首先,从git上拉取代码: 我们将新clone下来的项目打开,可以发现在git上原本是maven项目的工程,没有了maven的结构: 要解决这个问题,我们需要关闭这个项目,重新导入。 首先打开idea File->New->...
  • 这是个数学公式,但是想打代码(比如说想介绍一下这个代码的使用)的时候却不知道该怎么操作了。 其实有的人想到了,直接在外面再加上` ````,那就可以了吧。 这段话还会有个问题,那就是文中的“` ````”是...
  • 这几天,调试串口需要使用到git hub开源的android-serialport-api ...再使用github拉取代码,将遇到到问题记录,方便自己以后查阅。 1 使用https git clone https://github.com/cepr/android-serialport-api.
  • 多人合作开发一个项目时,Eclipse中使用git pull更新代码时经常会出现conflict(冲突)的问题,主要是由于多人操作同一个文件导致的。 使用git也没多久,今天终于摸索一套方法可以解决该问题,主要操作步骤如下: ...
  • 开发时有一个工程的一个文件的断点无效,VS 2005提示说当前不会命中断点。源代码与原始版本不同,请在断点选项里设置允许源代码... 实际上有比这个办法更好的办法,就是将出问题的文件用notepad打开,然后另存为Unico
  • 错误代码0x80070570

    万次阅读 2017-02-02 15:34:08
    u盘存储文件时弹错误代码0x80070570怎么办?相信不少朋友应该都遇到过使用u盘过程中出现了u盘存储文件时弹错误代码0x80070570。下面分享u盘存储文件时弹错误代码0x80070570解决方法,希望能帮到大家! ...
  • 问题: 昨天周一早上来到公司,发现跳闸停电了...半个钟之后老哥修好了,打开电脑一看 居然上不了网了,刚开始只是出现个黄色感叹号,但是搜索识别不了任何WiFi 瞎点的我看到了这个,于是乎我点了进去网络重置,...
  • understand分析代码

    万次阅读 2018-10-24 21:58:12
    分析法,从解决方案出发,从求解出发,去分析结论,找问题之间的关系。 understand是一款很强大的阅读代码软件。我通过一个java小代码的分析来梳理一下代码分析的过程。 系统外部学习,从使用者的角度来学习。...
  • 代码审查审什么

    万次阅读 2014-07-25 13:18:37
    代码审查审什么看着很多人做代码审查重点审格式和命名,制定的代码规范也主要偏重代码格式和命名,我真想骂一句操蛋,这真是浪费时间又解决不了问题。此篇文章就是骂完操蛋后奋笔快速敲下来的,有不妥之处请大家谅解...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 3,359,699
精华内容 1,343,879
关键字:

代码出问题了怎么办