当前位置: 开发笔记 > 后端 > 正文

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

作者：kmv2145234 | 来源：互联网 | 2023-07-25 15:01

注释是在代码表达意图时遭遇的失败。注释不能美化糟糕的代码用代码来阐述好注释法律信息对基本信息的注释对意图的解释阐释警示TODO注释，程序员认为应该去做

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

注释不能美化糟糕的代码

用代码来阐述

好注释

法律信息
对基本信息的注释
对意图的解释
阐释
警示
TODO注释&＃xff0c;程序员认为应该去做&＃xff0c;但是由于一些原因没用实现完的注释。
放大不合理之物的重要性
公共API描述

坏注释

喃喃自语/废话注释
多余的注释
误导性注释
循规式注释&＃xff1a;不需要给每一个函数进行注释
日志式注释
能用函数和变量时就别用注释
用于位置标识的注释
注释的代码
信息过多
不明显的联系

推荐阅读

server
微软Exchange服务器遭遇2022年版“千年虫”漏洞

微软Exchange服务器在新年伊始遭遇了一个类似于‘千年虫’的日期处理漏洞，导致邮件传输受阻。该问题主要影响配置了FIP-FS恶意软件引擎的Exchange 2016和2019版本。 ... [详细]

蜡笔小新 2024-12-25 14:08:03
api
深入解析：阿里实战 SpringCloud 微服务架构与应用

本文将详细介绍 SpringCloud 在微服务架构中的应用，涵盖入门、实战和案例分析。通过丰富的代码示例和实际项目经验，帮助读者全面掌握 SpringCloud 的核心技术和最佳实践。 ... [详细]

蜡笔小新 2024-12-26 03:50:43
api
libsodium 1.0.15 发布：引入重大不兼容更新

最新发布的 libsodium 1.0.15 版本带来了若干不兼容的变更，其中包括默认密码散列算法的更改和其他重要调整。 ... [详细]

蜡笔小新 2024-12-26 11:03:58
api
MicroATX与MATX：主板规格详解

本文详细介绍了MicroATX（也称Mini ATX）和MATX主板规格，探讨了它们的结构特点、应用场景及对电脑系统成本和性能的影响。同时，文章还涵盖了相关操作系统的实用技巧，如蓝牙设备图标删除、磁盘管理等。 ... [详细]

蜡笔小新 2024-12-25 18:53:29
redis
Python 的 10 个开发技巧！太实用了

1.如何在运行状态查看源代码？查看函数的源代码，我们通常会使用IDE来完成。比如在PyCharm中，你可以Ctrl+鼠标点击进入函数的源代码。那如果没有IDE呢？当我们想使用一个函 ... [详细]

蜡笔小新 2024-12-27 18:36:54
struct
数据库内核开发入门 | 搭建研发环境的初步指南

本课程将带你从零开始，逐步掌握数据库内核开发的基础知识和实践技能，重点介绍如何搭建OceanBase的开发环境。 ... [详细]

蜡笔小新 2024-12-27 16:38:48
grpc
Akka BackoffSupervisor的深入解析与实践

本文详细介绍了Akka中的BackoffSupervisor机制，探讨其在处理持久化失败和Actor重启时的应用。通过具体示例，展示了如何配置和使用BackoffSupervisor以实现更细粒度的异常处理。 ... [详细]

蜡笔小新 2024-12-27 15:04:09
port
优化MySQL InnoDB的IO性能：配置参数详解

本文深入探讨了如何通过调整InnoDB的关键配置参数来优化MySQL的随机IO性能，涵盖了缓存、日志文件、预读机制等多个方面，帮助读者全面提升数据库系统的性能。 ... [详细]

蜡笔小新 2024-12-27 13:00:29
上传
网络攻防实战：从HTTP到HTTPS的演变

本文通过一系列日记记录了从发现漏洞到逐步加强安全措施的过程，探讨了如何应对网络攻击并最终实现全面的安全防护。 ... [详细]

蜡笔小新 2024-12-27 11:34:50
server
利用存储过程构建年度日历表的详细指南

本文将介绍如何使用SQL存储过程创建一个完整的年度日历表。通过实例演示，帮助读者掌握存储过程的应用技巧，并提供详细的代码解析和执行步骤。 ... [详细]

蜡笔小新 2024-12-26 18:20:17
server
PHP 实现微信素材上传

本文介绍了如何使用PHP代码实现微信平台的媒体素材上传功能，详细解释了API接口的使用方法和注意事项，确保文件路径正确以避免常见的错误。 ... [详细]

蜡笔小新 2024-12-26 16:54:06
api
MySQL 索引与锁机制详解

本文详细介绍了 MySQL 的查询处理流程，包括从客户端连接到服务器、查询缓存检查、语句解析、查询优化及执行等步骤。同时，深入探讨了 MySQL 中的乐观锁机制及其在并发控制中的应用。 ... [详细]

蜡笔小新 2024-12-26 16:17:48
api
深入理解 ExtJS 类的别名机制

在 ExtJS 中，类的别名（alias）是开发过程中非常有用的一个特性。通过别名，开发者可以使用简短且易于记忆的名称来引用复杂的类名。本文将详细探讨如何在 ExtJS API 中使用和定义别名，并提供实例说明。 ... [详细]

蜡笔小新 2024-12-26 15:19:42
redis
MySQL缓存机制深度解析

本文详细探讨了MySQL的缓存机制，包括主从复制、读写分离以及缓存同步策略等内容。通过理解这些概念和技术，读者可以更好地优化数据库性能。 ... [详细]

蜡笔小新 2024-12-26 15:15:06
server
Ralph的Kubernetes进阶之旅：集群架构与对象解析

本文深入探讨了Kubernetes集群的架构和核心对象，详细介绍了Pod、Service、Volume等基本组件，以及更高层次的抽象如Deployment、StatefulSet等，帮助读者全面理解Kubernetes的工作原理。 ... [详细]

蜡笔小新 2024-12-26 14:15:32

kmv2145234

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章