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

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

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

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

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

注释不能美化糟糕的代码

用代码来阐述

好注释

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

坏注释

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

推荐阅读

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

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

蜡笔小新 2024-12-25 14:08:03
token
TCP长连接设备管理平台：架构与功能概览

本文介绍了基于TCP长连接的设备管理平台的设计理念、技术选型及主要功能模块。最初，项目旨在实现简单的协议测试，但随着需求扩展，逐步演变为一个完整的前后端分离系统。 ... [详细]

蜡笔小新 2024-12-25 09:07:38
token
PHP插件机制的实现方案解析

本文深入探讨了PHP中插件机制的设计与实现，旨在分享一种可行的实现方式，并邀请读者共同讨论和优化。该方案不仅涵盖了插件机制的基本概念，还详细描述了如何在实际项目中应用。 ... [详细]

蜡笔小新 2024-12-24 15:39:18
spring
技术变现之道：从日常工作中挖掘潜力

本文探讨了如何在日常工作中通过优化效率和深入研究核心技术，将技术和知识转化为实际收益。文章结合个人经验，分享了提高工作效率、掌握高价值技能以及选择合适工作环境的方法，帮助读者更好地实现技术变现。 ... [详细]

蜡笔小新 2024-12-24 15:21:23
struct
深入解析Redis内存对象模型

本文详细介绍了Redis内存对象模型的关键知识点，包括内存统计、内存分配、数据存储细节及优化策略。通过实际案例和专业分析，帮助读者全面理解Redis内存管理机制。 ... [详细]

蜡笔小新 2024-12-23 14:50:23
struct
Java编程的核心要素与关键技术

本文探讨了Java编程的核心要素，特别是其面向对象的特性，并详细介绍了Java虚拟机、类装载器体系结构、Java类文件和Java API等关键技术。这些技术使得Java成为一种功能强大且易于使用的编程语言。 ... [详细]

蜡笔小新 2024-12-23 12:58:30
struct
Lesson09异常

异常要理解Java异常处理是如何工作的，需要掌握一下三种异常类型：检查性异常：最具代表性的检查性异常是用户错误或问题引起的异常ÿ ... [详细]

蜡笔小新 2024-12-23 10:49:54
package
Linux 透明防火墙（网桥模式）的部署与配置

本文介绍如何在现有网络中部署基于Linux系统的透明防火墙（网桥模式），以实现灵活的时间段控制、流量限制等功能。通过详细的步骤和配置说明，确保内部网络的安全性和稳定性。 ... [详细]

蜡笔小新 2024-12-25 13:17:38
package
SVN日志查看时出现超时问题的解决方案

本文详细描述了在使用SVN查看日志时遇到的超时问题，特别是涉及中文路径的情况。通过深入研究和测试，找到了有效的解决方法，并提供了优化建议。 ... [详细]

蜡笔小新 2024-12-24 20:15:12
yii
TechStride 网站

TechStride 成立于2014年初，致力于互联网前沿技术、产品创意及创业内容的聚合、搜索、学习与展示。我们旨在为互联网从业者提供更高效的新技术搜索、学习、分享和产品推广平台。 ... [详细]

蜡笔小新 2024-12-24 20:04:54
yii
通过Web界面管理Linux日志的解决方案

本指南介绍了一种利用rsyslog、MariaDB和LogAnalyzer搭建集中式日志管理平台的方法，使用户可以通过Web界面查看和分析Linux系统的日志记录。此方案不仅适用于服务器环境，还提供了详细的步骤来确保系统的稳定性和安全性。 ... [详细]

蜡笔小新 2024-12-24 17:11:38
yii
C#编程中防止系统休眠和显示器关闭的方法

本文详细介绍了如何在C#程序运行期间防止系统进入休眠模式以及显示器关闭，提供了具体的实现代码示例，并解释了其应用场景。这不仅有助于提高程序的稳定性，还能优化能源管理。适合需要处理长时间任务（如下载或批处理）的开发者参考。 ... [详细]

蜡笔小新 2024-12-23 11:33:31
ssl
阿里云ecs怎么配置php环境,阿里云ecs配置选择

阿里云ecs怎么配置php环境,阿里云ecs配置选择 ... [详细]

蜡笔小新 2024-12-23 11:12:07
ssl
深入理解Lucene搜索机制

本文旨在帮助读者全面掌握Lucene搜索的编写步骤、核心API及其应用。通过详细解析Lucene的基本查询和查询解析器的使用方法，结合架构图和代码示例，带领读者深入了解Lucene搜索的工作流程。 ... [详细]

蜡笔小新 2024-12-23 11:06:10
token
DCG 股东信：解答关键问题与未来展望

DCG 创始人兼首席执行官 Barry Silbert 发布致股东信，详细解答了 19 个核心问题，并分享了公司未来的发展方向。 ... [详细]

蜡笔小新 2024-12-23 11:00:58

kmv2145234

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

Tags | 热门标签

RankList | 热门文章