代码简洁之注释

最新推荐文章于 2021-05-17 13:28:21 发布
最新推荐文章于 2021-05-17 13:28:21 发布
阅读量203 收藏
点赞数
分类专栏： 心得 文章标签： clean code
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/shayne000/article/details/98471566
版权

1. 注释不能美化糟糕的代码

写注释的常见动机之一是糟糕的代码的存在。我们编写一个模块，发现它令人困扰、乱七八糟。我们知道，它烂透了。我们告诉自己：“喔，最好写点注释！”不！最好是把代码弄干净！

带有少量注释的整洁而有表达力的代码，要比带有大量注释的零碎而复杂的代码像样得多。与其花时间编写解释你搞出的糟糕的代码的注释，不如花时间清洁那堆糟糕的代码。

2. 好注释

法律信息
提供信息的注释
对意图的解释
阐释
警示

3. 坏注释

喃喃自语
多余的注释
误导性注释
循环式注释
日志式注释
能用函数或变量肘就别用注释

shayne000
关注
专栏目录
代码就是注释
QyLost
07-14 321
代码的可读性往往比加上若干累赘注释要好的多，以下一个简单的例子就能体现出来。以下只是简单示例，本文想要陈述的是逻辑性的代码要比完美的注释要好得多。 不知读者是否能从以下代码中悟到。 //submit order private void btnSubmit_Click(object sender, EventArgs e) { if (id == -1) { Add(); } else { Edit(); } } privat
代码简洁之道——注释
yezihumengjuan的专栏
06-15 508
（1）注释不能美化糟糕的代码：与其花时间编写jianshi
《简洁代码之道》总结四之简洁的注释
nicolelili1的专栏
11-28 1081
别给糟糕的代码加注释--------------重新写吧。 注释的恰当用法是弥补在用代码表达意图时遭遇的失败。 1、注释不能美化糟糕的代码 带有少量注释而有表达力的代码，要比有大量注释的零碎而复杂的代码像样的多。与其花时间编写解释你搞出的糟糕的代码的代码注释，不如花时间清洁那堆糟糕的代码 2、用代码来阐述 只需要创建一个描述与注释所言同一事物的函数即可。 3、好
Lombok注解，让你的代码更简洁
猪猪代码
05-08 244
Lombok注解 说明 : Lombok 注解可以让你的setter、getter、toString、构造器等方法不再需要手动写入，可以让你的代码更佳简洁，让开发更佳高效！！！ 目录 : 安装Lombok插件 @Setter和@Getter注解 @NoArgsConstructor和@AllArgsConstructor 注解 @Builder注解 其他注解 安装 Lombok 插件 在...
简单的java程序代码带注释,Java：基于注释的代码注入的简单技术？
weixin_31327207的博客
03-10 185
使用反射很容易只使用@Audit注释方法,就像JUnit中的测试运行器一样：public interface Login {void login(String name, String password);}public class LoginImpl implements Login {@Audit(handler = LoginHandler.class)public void login(S...
本地小说阅读器，支持深色模式，Wifi传书，代码简洁有注释(
最新发布
03-06
本地小说阅读器，支持深色模式，Wifi传书，代码简洁有注释(local text reader, support dark modal, upload text by wifi).zip
Dreamweaver怎么给代码添加注释?
09-22
记住，良好的注释应该简洁明了，描述代码的目的和功能，而不是单纯复述代码本身。同时，注释应保持更新，避免成为过时的信息源。通过合理使用Dreamweaver的注释功能，你可以使你的代码更加清晰，便于团队协作和未来...
css写菜单：简洁注释版 [2]特效代码
03-20
在这个"css写菜单：简洁注释版 [2]特效代码"中，我们将深入探讨如何通过CSS实现具有注释的简洁菜单效果。以下是关于这个主题的详细知识： 1. **CSS基础**： - CSS是用于描述HTML或XML（包括如SVG、MathML等各种XML...
css写菜单：简洁注释版 [1]特效代码
03-20
在这个“css写菜单：简洁注释版”中，我们将探讨如何用CSS来创建一个功能完备且易于理解的菜单。这个教程特别强调了代码的简洁性和注释的清晰性，使得初学者也能轻松上手。 首先，我们来了解CSS的基本结构。CSS是由...
C语言经典源代码220例带注释讲解【重点推荐】
12-25
C语言经典源代码220例。绝对经典的源代码，由浅入深，每个实例都带有注释和讲解，是C语言入门和提高的难得好教材，还有大多数基本算法的实现例子，无论学习还是工作都十分有用。覆盖了C语言学习的所有知识点。内有目录。已经压缩成zip格式。重点推荐。
Java程序的简单注释
zzzbiu的博客
07-27 623
Java小白，找了一段代码，有很多不懂得地方，一个个百度出来的 写一段代码，要求输入任意5个整数，输出它们的和。 1. import java.util.*; 2. public class Demo { 3. public static void main(String[] args){ //必须存在的，独立运行所必须的； 4. int intArray[] = new int[5];//...
一个简单的Java应用程序及注释
u013009552的博客
07-04 343
Core Java 3.1、3.2笔记第三章 Java的基本程序设计结构3.1 一个简单的Java应用程序3.2 注释 第三章 Java的基本程序设计结构 Java语言规范可以从http://docs.oracle.com/javase/specs网站中下载。 3.1 一个简单的Java应用程序 package CoreJava3_1; public class FirstSample { public static void main(String[] args) { Syste
简单易学系列之C++注释
C/C++/Linux/MySQL
04-20 329
●注释 单行注释： // 描述信息 通常放在一行代码的上方，或者一条语句的末尾，对该行代码说明 多行注释：/* 描述信息 */ ，对该段的代码做整体说明 提示：编译器在编译代码时，会忽略注释的内容 ...
含注释的简单的c语言程序代码,[编程入门]利润计算-最简洁代码(C语言代码)
weixin_30248619的博客
05-17 1094
# 利用switch中case的穿透性最大限度简洁代码结构#### 目录* 需要知识* 简单介绍* switch语句详解* 无注释代码* 含注释代码* 总结* 加入我们## 需要知识：* 了解基本数据类型 int;* 会使用 scanf 输入语句；* 会使用 printf 输出语句；* 知道 switch 的基本特性(case的穿透性)；* 拥有能自主分析代码的基本能力 ┑(￣Д ￣)┍ 。## ...
Java注释的重要性
Java_King__的博客
09-30 1276
注释 注释并不会被执行，而是写给人看的 书写注释是一个非常好的习惯 平时写代码一定要注意规范 Java中的注释有三种： 单行注释 // 多行注释 /**/ 文档注释 /** */ /*** * _ooOoo_ * o8888888o * 88" . "88 * (| -_- |) *
好玩的注释
weixin_33971130的博客
01-13 1209
最多人用的佛祖 // _ooOoo_ // o8888888o // 88" . "88 // (| -_- |) // ...
玩转代码：32个有趣的代码注释
读芯术的博客
04-09 3268
全文共3581字，预计学习时长23分钟图源：unsplash代码注释是一种用“高级”英语陈述，描述程序将要做什么的“艺术”。有人嫌它丑，也有人觉得它还蛮有用的。但还有一些“闷骚”的...
项目必备！永无 bug 注释
热门推荐
Star_Monkey的博客
07-13 1万+
如来佛代码注释，保佑代码无BUG /* _ooOoo_ o8888888o 88" . "88 (| -_- |) O\
代码注释规范与最佳实践
对于头文件（.h），注释应简洁地介绍声明的类或函数的作用和用法；对于实现文件（.cc），注释可能包含更多实现细节或算法讨论，但应避免简单的复制粘贴，确保注释与实际代码内容相符。 3. 类注释（Class Comments）...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值