《代码整洁之道》笔记03——注释

最新推荐文章于 2022-04-21 23:30:27 发布
最新推荐文章于 2022-04-21 23:30:27 发布
阅读量242 收藏
点赞数
分类专栏： 一些学习的研究 代码整洁之道 文章标签： 代码规范
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gdutRex/article/details/105942458
版权

注释是在代码表达意图时遭遇的失败。

注释不能美化糟糕的代码

用代码来阐述

好注释

  1. 法律信息
  2. 对基本信息的注释
  3. 对意图的解释
  4. 阐释
  5. 警示
  6. TODO注释，程序员认为应该去做，但是由于一些原因没用实现完的注释。
  7. 放大不合理之物的重要性
  8. 公共API描述

坏注释

  1. 喃喃自语/废话注释
  2. 多余的注释
  3. 误导性注释
  4. 循规式注释：不需要给每一个函数进行注释
  5. 日志式注释
  6. 能用函数和变量时就别用注释
  7. 用于位置标识的注释
  8. 注释的代码
  9. 信息过多
  10. 不明显的联系
Shopee_Rex
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
代码整洁之道笔记
07-19
个人阅读代码整洁之道所做的笔记
代码整洁之道读书笔记.zip
08-21
个人读书笔记,学习共享,希望每个苦恼于代码一坨坨混乱不堪的程序员都能学习. * 整洁代码的意义？ 可读性，可维护性。 * 如何写出整洁代码？ 1.只做一件事 2.不重复 3.有表达力 * 整洁代码的态度要求，要遵守...
代码整洁之道读书笔记——第四章：注释
pengbo6665631的博客
10-21 192
第四章 注释 尽管需要注释，但是我们尽量减少注释 4.1 注释不能美化糟糕的代码 与其花时间为那些糟糕的代码写注释，还不如花时间好好清理那些糟糕的代码 4.2 用代码来阐述 很多时候代码就可以解释我们大部分的意图 比方这样的代码： 你愿意看到这个？ if (info.gender == FEMALE && info.age == ADMIN) 还是这个？ if (info.isFemaleAdmin()) 我们只需要创建一个描述与注释所言同
代码整洁之道读书笔记——第一章：整洁代码
pengbo6665631的博客
11-15 571
软件质量，不仅仅依赖于项目架构和项目管理，同样重要的是代码质量！！！ 序 神在细节之中，其实干什么事都一样，从小到大，一直明白一个道理：细节决定成败！ 软件架构在开发中占据重要地位。其次，宏达建筑的最细小的部分，比如关不紧的门、有点没铺平的地板，甚至是凌乱的桌面，都会将整个大局毁灭殆尽。这就是代码整洁之所道。 全员生产维护(TMP)，TMP的主要支柱之一就是5S原则体系，5S哲学包括...
代码整洁之道读书笔记——第五章：格式
pengbo6665631的博客
10-21 242
第五章 格式 团队应该一致同意采用一套简单的格式规则 5.1 格式的目的 能让代码工作，这是最基本的要求。但是代码格式同样很重要，我们今天编写的功能，很有可能下一个版本就会被修改 5.2 垂直格式 短文件通常比长文件易于理解 5.2.1 向报纸学习 名称应该一目了然，而且报纸的文章多数短小精悍 5.2.2 概念间垂直方向上的区隔 变量之间可以不用空行，方法和方法间要空行，变量和方法之间也要空行，空白行隔开了概念 5.2.3 垂直方向上的靠近 靠近的代码暗示了它们之间的紧密关系
代码整洁之道读书笔记——第三章：函数
pengbo6665631的博客
10-20 205
第三章 函数 作者将一个复杂的函数提炼为9行代码，告诉了我们什么样的代码易于阅读 3.1 短小 作者的建议是一个函数封顶20行最佳，每个函数之说一件事，每个函数依序把你带入下一个函数。 if、else、while语句等，其中的代码应该只有一行，大概是一个函数的调用语句。调用函数应具有比较有说明性的名称，这样也能增加一定的文档的价值。 我这么理解：20行封顶、函数带入函数、控制代码块中的行数、控制缩进。 我们可能无法做到作者说的if、else、while语句的代码块只有一行，缩进层级只是一层
《代码整洁之道》读书笔记
06-29
《代码整洁之道》读书笔记
读代码整洁之道幻灯片笔记
09-14
代码整洁之道是一本主要写代码规范的书籍，我读完以后为了给同事们分享里面的重点知识，做了几个幻灯片，主要是各个知识点和笔记。
代码整洁之道幻灯片笔记
10-08
这是有关代码整洁之道的幻灯片笔记，简单介绍了本书的一些重点知识点。
TypeError: this.getOptions is not a function 引入less一直报错
热门推荐
gdutRex的博客
02-02 3万+
错误提示如下 Syntax Error: TypeError: this.getOptions is not a function @ ./node_modules/vue-style-loader??ref--10-oneOf-1-0!./node_modules/@vue/cli-service/node_modules/css- loader/dist/cjs.js??ref--10-oneOf-1-1!./node_modules/vue-loader/lib/loaders/stylePost
安装electron项目的时候老是报错：Command failed.
gdutRex的博客
01-14 1万+
问题描述 安装electron项目的时候，在下载包的时候报错 错误描述主要是 错误1：socket hang up error E:\theia\node_modules\electron: Command failed. Exit code: 1 Command: node install.js Arguments: Directory: E:\theia\node_modules\electron Output: RequestError: socket hang up at ClientR
微信小程序自适应方法
gdutRex的博客
07-06 1万+
微信小程序适配适配？如何适配原理rpx如何利用rpx图片适配元素布局其他总结 适配？ 由于每一个手机屏幕大小尺寸不一致，这就导致了小程序页面显示的差异存在，为了尽量避免因为尺寸而出现的界面混乱。 如何适配 原理 我们以每一个屏幕宽度为标准尺，通过比例计算获取相应的大小和位置。这样可以尽可能适配各种机型，但是如果面对差距比较大的设备，如PC、ipad等，就需要考虑不同设备的适配方案。一般都是可以获取...
vscode中的eslint的ts文件不会错误提示，但是编译的时候报错了
gdutRex的博客
02-02 6884
这是因为vscode的eslint的配置没有设置typescript文件。 第一步 打开设置首选项》设置 第二步：搜索validate 第三步：添加typescript 结果 在ts文件提示eslint错误了。
prettier在代码提交前自动格式化
gdutRex的博客
04-21 4624
prettier使用husky配置git提交自动格式化文件
从0开始搭建一个疫情地图小程序——数据爬虫篇
gdutRex的博客
03-04 3707
前言 其实这个小程序一个月前就已经做好了，但是当时忙着实习和毕设还有一些乱七八糟的事情，所以拖到现在才来做总结。 文章目录前言源代码数据来源分析请求中国地图svg数据一些制作好的图片从JS文件请求入手从url网址发现爬虫接口编写爬虫搭建服务器未处理的数据使用cheerio解析html将这些文件保存到我们需要的格式并且保存为js文件保存文件删除文件 源代码 数据来源 在春节的时候，疫情地图一开始用的...
JavaScript face++ 人体识别API 与 人体抠像功能（一）
gdutRex的博客
05-31 3319
最近在开始接触网上API调用 完成了一个关于face++人体识别API，并通过这个API实现人体抠像功能。既然要实现人体抠像，我们顺便学习下，JavaScript调用摄像头的方法吧。有个博客写的很好 大家可以去看这个 我摄像头主要是参考他写的博客。我这里简单介绍下首先在html添加标签 <video><audio>这2个标签分别代表视频和音频1.打开摄像头有2个版本的方法，...
vscode中prettier与eslint一起使用格式化时候会报错
gdutRex的博客
08-26 3278
代码风格与代码检测冲突 我们经常使用prettier与eslint进行代码格式化与代码检测，但是经常遇见格式化之后依然存在代码检测的异常，这主要是因为eslint的配置没有与prettier的规则设置为相同。 我查看了网上给的设置都比较过时了，prettier官方提供了一个新的方法 例子 通过prettier格式化之后，报错 设置方法 首先在vscode的setting.json中添加prettier的设置 "editor.codeActionsOnSave": { // For ESLi
VUE中使用localStorage实现跨标签页面的通信
gdutRex的博客
10-22 3257
前言 目前出现了一个需求，需要父页面打开新的子页面，子页面提交表单之后，关闭子页面，然后把数据返回给父页面。 本来考虑使用sharedWorker，但是由于兼容性太差了，就弃用了。看到网上的介绍可以使用localStorage来实现，我就尝试了下。下面是一些具体的细节。 开始 整体流程如图所示： 需求分析 子页面需要知道自己的父页面对应的是谁，所以父页面打开子页面的时候需要传输一个父页面的KEY值 由于表单是使用dialog来显示，需要注意避免出现事件重复注册的，及时销毁事件，保留监听事件的唯一。 由于
sparksql代码笔记03——连接hive
最新发布
06-28
好的，下面是SparkSQL代码笔记03——连接Hive的中文回复： 在SparkSQL中，我们可以通过以下步骤连接Hive： 1. 首先，需要在SparkSession中启用Hive支持，可以使用以下代码： ``` from pyspark.sql import ...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值