• Clean code 关于注释、函数、命名的感想


    最近在看代码整洁之道(Clean code)这本书,其实看的有点痛苦,因为越看就会越想自己写的代码是什么鬼?一些不知所云的命名,不整洁的代码格式,本想诠释代码的意思却添加了一段段废话,还有那些被强制加上去的署名和某年某月的修改信息。

    此时的我只想痛改前非,但是我知道看书的时候觉得自己懂了,实际写起来又会很糟糕。我以大牛为榜样,看看自己离这个目标还差的很远我又很烦躁。也许我不该烦,应该从现在开始注意自己写代码的风格。

    首先说下命名:

    尽管给函数,变量,类等命名没有充斥着a,b,c但是也命名过isDisplay,ApiData等名字,多少有点词不达意,以偏概全。

    作者说了,宁愿命名很长也不愿起的名字不知所云。最好是看名字就知道是代表什么,这样连注释都不用写。

    我现在感觉自己快傻了,每天干着重复的活,起着同样的名字,我的心里是不愿意这样的。

    关于方法,要求要短,一个方法只能干一件事情,传入的参数最好不能超过三个,超过三个就说明可以重构。最合适的参数是不传入参数。名字不宜重复。

    要把程序当作讲故事一样写。

    关于注释:

    好的注释包括法律信息,能提供读者以信息的注释而不是一堆没用的废话、署名。

    长篇大论的注释是不合适的。不要注释不要了的代码,直接删掉。注释应该明确清晰,最好不用注释,因为注释会随着时间的流逝变得词不达意。

    这点我在工作中也有遇到,代码改了,注释没改,这样的注释根本就没用,还会干扰阅读,一般都会被读者忽略。而且还会给人一种这些代码没有被很好的维护的感觉,当然就不会被很好的对待。

    看了很多书,学会了很多知识,但是我还是不能写好我的代码。我这个人就是太想一口气吃成胖子了,慢慢磨练自己的代码吧。

  • 相关阅读:
    【C++】类的特殊成员变量+初始化列表
    SM Java实现
    Android使用OKHttp3实现下载(断点续传、显示运行进度)
    codeforces 486C Palindrome Transformation 贪心求构造回文
    手把手教你画AndroidK线分时图及指标
    怎样使用 iOS 7 的 AVSpeechSynthesizer 制作有声书(3)
    C# 读取Excel中的数据
    Caused by: com.mysql.jdbc.exceptions.jdbc4.MySQLSyntaxErrorException: Query was empty
    java debug
    8种移动APP导航设计模式对照
  • 原文地址:https://www.cnblogs.com/xiaoxinstart/p/12064016.html
Copyright © 2020-2023  润新知