英文阅读
文章平均质量分 51
WeiXiao_Hyy
这个作者很懒,什么都没留下…
展开
-
阅读笔记——《代码整洁之道》ch4
多余的注释并不能比代码本身提供更多A的信息。没有证明代码的意义,也没有给出代码的意图或逻辑。为只做一件事的短函数选个好名字,通常要比写函数头注释要好。所谓每个函数都要有Javadoc或每个变量都要有注释的规矩全然是愚蠢可笑的。注释是写代码永远避开不了的话题,需要知道什么是好的,必要的注释。任何迫使读者查看其他模块的注释,都没能与读者沟通好,不值所费。警告其他程序员会出现某种后果的注释也是有用的。别在本地注释的上下文环境中给出系统级的信息。唯一真正好的注释是你想办法不去写的注释。可以改成以下没有注释的版本。原创 2024-05-16 21:55:18 · 248 阅读 · 0 评论 -
阅读笔记——《代码整洁之道》ch3
上述代码如果只看函数名称大概率是不知道会初始化session的,应将函数名称修改为checkPasswordAndInitialSession();如果switch如果只是出现一次,用于创建多态对象,而且隐藏在某个继承关系中,在系统其他部分看不到,就还能容忍。算法在函数体中重复了4次,修改时则需要重新修改4个地方,同时也会增加4次放过错误的可能性。上述函数在函数体中修改了pageText的值,结果往往会让人费解。最理想的参数数量是零,其次是一,再次是二,尽量避免三。使用标识参数,则本函数不止做一件事情。原创 2024-05-15 23:50:56 · 272 阅读 · 0 评论 -
阅读笔记——《代码整洁之道》ch2
另一种解释为把单个参数放到群集(collection)中则不应该使用add,可以使用insert或append之类词来命名才对。类名和对象名应该是名词或名词短语,如Customer,WikiPage,Account,避免使用Manager,Processor,Data或Info这样的类名。给每个抽象概念选一个词,使用fetch,retrieve和get来给多个类中的同种方法命名。方法名应当是动词或动词短语,如postPayment,deletePage或save。别给名称添加不必要的语境。原创 2024-05-15 23:11:22 · 467 阅读 · 2 评论 -
英文阅读-LinkedIn‘s Tips for Highly Effective Code Review
comment需要简洁易懂,比如"reduces duplication", "improves coverage"等等。养成CR习惯,不要当成一种负担。养成一种心态:别人要CR我的代码,至少我的代码在自己CR下能够满意。减少不必要的comment,比如代码格式有问题,开发者需要将CR意见当成有用的工具。在提交pr的同时需要描述本次修改的“动机”,有助于提高代码文档质量。当reviewer看到优秀代码需要给出正反馈。每一次变更都需要通过单元/接口测试。原创 2024-01-23 22:36:05 · 428 阅读 · 0 评论