代码不会骗人，但有时注释会

注释起着很重要的作用，但是如果可以的话，尽量不要使用注释，而是书写更多的描述性代码。这是因为在你修改代码的时候，注释往往会被忽视。因此我这样说：注释有时会骗人（有错误），因为它周围的代码已经改变，而它自己没有被修改。

图源：unsplash

有三种方法书写代码：

· 在代码中使用注释。

· 将注释写在单独的文件中。

· 书写自我说明的代码。

我来详细说明一下最后一点。下面是书写更多描述性代码的意义：

· 好好设计代码库，使它方便查找且结构合理。

· 不要尝试保存缩写字母。在对变量、类和函数命名的时候使用全称，比如不用wm用windowManager，不用rf用readFileToString。当你或者其他人间隔数月再看代码试图理解其意思时，这种命名方式会有很大帮助。

· 尽可能多地提取函数并让它们各司其职。根据其功能进行命名，比如，创建一个将文件读入字符串的函数，将其命名为readFileToString(String fileName)，不用仔细阅读代码就能明白它的作用。

最理想的情况是，你的代码由一系列这样的函数调用组成，读起来就像人类语言一样。只有在需要的时候，读者才会去深入理解，这些代码本身就有说明的作用。

代码不会骗人，但有时注释会相关推荐

Xcode12.5的自定义代码块的使用和函数注释(学会事半功倍)
Xcode12.5的自定义代码块的使用和函数注释(学会事半功倍) 第一篇快捷键的定义 @property (nonatomic , strong) <#type#> <#name# ...
BP神经网络预测回归MATLAB代码（代码完整可直接用，注释详细，可供学习）
BP神经网络预测回归MATLAB代码(代码完整可直接用,注释详细,可供学习) 一.前言二.代码部分 2.1 初始化 2.2 读取数据 2.3 设置训练集和测试集 2.4 数据归一化 2.5 求解最佳 ...
天津理工大学《操作系统》实验二，存储器的分配与回收算法实现，代码详解，保姆式注释讲解
天津理工大学<操作系统>实验二,存储器的分配与回收算法实现,代码详解,保姆式注释讲解实验内容 1．本实验是模拟操作系统的主存分配,运用可变分区的存储管理算法设计主存分配和回收程序,并不 ...
GitHub的AI写代码翻车了，会在注释里给你写上what the f***，因为...
以下文章来源方志朋的博客,回复"666"获面试宝典来源 | 新智元 GitHub Copilot凭借着自动生成代码这个强有力的噱头,推出之后就成为了讨论的焦点. Copilot建 ...
php代码清除空格注解,去除php注释和去除空格函数分享
虽然php5中已有php_strip_whitespace方法可以返回删除注释和空格后的PHP源码的功能,为了学习,这里为大家提供一个自己的方法,也可以去除代码中的空白和注释,代码如下: . 代码如下 ...
IDEA代码放大缩小快捷键设置、注释、标识符以及关键字。
IDEA代码放大缩小快捷键设置进入File Settings进行配置,找到Keymap,在左边搜索框搜索f.回车就会看到 DEecrease Font Size,右键快捷键选择Add Mouse S ...
CNN经典网络模型（四）：GoogLeNet简介及代码实现（PyTorch超详细注释版）
目录一.开发背景二.网络结构三.模型特点四.代码实现 1. model.py 2. train.py 3. predict.py 4. spilit_data.py 五.参考内容一.开发背景 ...
一行代码告诉你为什么python代码中要加#coding:utf-8注释
初学者要么不大理解#coding:utf-8注释,但是会简单跟随着这一"习俗": 要么不大重视加这个注释,想着反正就是注释嘛,可有可无. 君子动手不动口,先上代码: print(r ...
CNN经典网络模型（二）：AlexNet简介及代码实现（PyTorch超详细注释版）
目录一.开发背景二.网络结构三.模型特点四.代码实现 1. model.py 2. train.py 3. predict.py 4. spilit_data.py 五.参考内容一.开发背景 ...

代码不会骗人，但有时注释会

代码不会骗人，但有时注释会相关推荐

最新文章

热门文章