注释是恶魔,请不要再写一行的注释
你可以从你们现在项目里面随便找几处注释看看写注释的代码是不是存在如下两种毛病之一1. 命名不准确2. 方法太长超过50行。如果你找到的代码没有出现上面两种毛病而注释依然存在那你再看看这个注释是否有实际意义是不是这个注释不要也无所谓呢。注释是恶魔这个观点可能你第一次看到你可能很难接受因为写了这么多年的注释你从未想过注释居然是恶魔所以你看到这个观点的时候可能就会本能的找出1000种理由反对绝对不可能实现啊什么的但是这个观点并不是今天才出现相信很多年前就有人提出现在已被越来越多的人认可。我第一次接受到这个观点还是从一个美国客户十几年编程经验的技术大牛那里2011年他让我们不要写注释。他当时主要意思是我们写的中式英语他猜起来太费劲所以他后面又安慰我们说“好的代码是不需要注释的”而我从此就将他后面那半句话奉为至宝。注释是恶魔它将我们的代码变得很难理解。就像本文开篇说的你可以找找你们项目中出现注释的地方要么命名不准确要么方法太长。你可以随机找10处注释看看有几处是恶魔欢迎贴到评论中。举一个以前项目中的例子吧命名不准确的例子在这个例子中其实将is换成can就不需要注释了。写注释让代码更难读。首先如果一个程序员可以随便写注释那么他对命名准确性和方法长度的控制就不会那么在意写代码更随意代码质量比不能写注释的程序员更大几率低下。其次代码注释只是在写代码的时候提供说明如果读代码都依靠注释的话那一个类被另一个类引用来引用去的就根本没法阅读了。所以“写注释是为了让代码更易读”本身就是站不住脚的。不写一行注释根本就做不到这句话可能从你阅读本文开始在心里面重复了无数遍这也是大多数人的心声。其实前面说的写注释让代码更难读的观点很多朋友从内心上是认可的。因为确实没有办法啊有的方法业务逻辑复杂不知不觉方法已上百行有的命名还是中西结合的不写注释自己第二天就读不懂了。所以真是纠结内心承受百般折磨。写到这里突然想起在园子里看到的一个笑话说一个公司的产品每年都在更新换代因为每年新招的程序员都要把程序重新写一遍。“零注释”根本做不到如果你丛刻开始怀疑自己的这个观点那你就可能做得到。如何做到不写一行注释1. 从现在开始强迫自己不要写注释。2. 控制每个方法不超过50行用方法定义来描述方法的实现逻辑。3. 变量命名不要太过随便。本文想要告诉大家的是零注释一点都不难。我们团队大约从2012年开始全面执行零注释后面经历2个产品项目多个外包项目积累的经验越来越多获得的质量效果越来越好零注释越来越深入人心。零注释这个编码规则也是我们团队近些年质量建设非常重要的里程碑之一再此分享给大家。如果能够影响你一点点那都足够了。附2个我们的代码片段虽没有注释大家不妨猜猜这两个方法做什么用的。1. 查询的例子2. 更新的例子

相关新闻

告别死机、无惧高温工业级 eMMC 震撼来袭!

告别死机、无惧高温工业级 eMMC 震撼来袭!

在工业自动化、车载电子及物联网设备的开发中,存储芯片的稳定性往往直接影响整个系统的生命周期。与消费级产品不同,嵌入式设备常常面临高低温交变、电磁干扰、电源波动乃至无人值守的运行环境。在这种背景下,eMMC作为主流的嵌入式存储方案&a…

2026/10/14 5:12:34 阅读更多 →
2026论文工具深度测评✨别乱花钱!真正能过双检的只有它

2026论文工具深度测评✨别乱花钱!真正能过双检的只有它

奉劝所有2026毕业生! 选论文工具别只看免费、只看噱头🙅 今年高校严查重复率AIGCAI痕迹双检 很多老牌工具直接失效、普通AI写作必判违规 实测全网主流论文工具,筛出唯一适配2026最新审核规则的全能王者,刚需党直接锁死✅ &…

2026/10/2 14:25:38 阅读更多 →
3分钟快速上手:163MusicLyrics - 网易云QQ音乐歌词下载神器终极指南

3分钟快速上手:163MusicLyrics - 网易云QQ音乐歌词下载神器终极指南

3分钟快速上手:163MusicLyrics - 网易云QQ音乐歌词下载神器终极指南 【免费下载链接】163MusicLyrics 云音乐歌词获取处理工具【网易云、QQ音乐】 项目地址: https://gitcode.com/GitHub_Trending/16/163MusicLyrics 还在为音乐播放器缺少歌词而烦恼吗&#…

2026/10/4 11:54:19 阅读更多 →

最新新闻

8款AI工具助力本科论文写作全流程

8款AI工具助力本科论文写作全流程

1. 项目概述作为一名经历过本科论文写作的过来人,我深知选题难、资料少、时间紧是困扰大多数学生的三大难题。去年帮导师做AI工具测评时,意外发现了一批对论文写作帮助极大的学术平台,经过半年实测,筛选出8个真正能提升效率的AI辅…

2026/10/14 7:24:38 阅读更多 →
GPU利用率从12%到80%:深度学习推理性能优化实战

GPU利用率从12%到80%:深度学习推理性能优化实战

1. 事故现场还原:一个让所有算法工程师血压飙升的夜晚1.1 从“训练快得飞起”到“推理慢如蜗牛”项目上线前的最后一个晚上,整个团队都在做最后的压测。训练阶段一切顺利,模型在验证集上的指标漂亮得让人想发朋友圈。但当我们把模型部署到推理…

2026/10/14 7:24:38 阅读更多 →
OpenClaw跨平台部署实战:Windows/macOS/Linux完整环境搭建指南

OpenClaw跨平台部署实战:Windows/macOS/Linux完整环境搭建指南

OpenClaw 这个框架,我第一次接触是在一次内部自动化脚本大重构的时候。当时手上有个活儿,要同时对接好几个数据源、定时跑批、失败重试,脚本越写越臃肿,日志、异常处理、参数校验全揉在一起,改一个环节就怕动到另一块。…

2026/10/14 7:24:38 阅读更多 →
SQLite+FTS5+BM25构建AI上下文感知能力

SQLite+FTS5+BM25构建AI上下文感知能力

1. “context-mode”到底是什么?别被术语唬住,它本质是让AI真正“听懂上下文”的工程化开关最近在好几个技术群里看到有人问:“context-mode开了没?”、“这个插件依赖context-mode,但文档里根本没说怎么配”&#xff…

2026/10/14 7:24:38 阅读更多 →
不写代码也能搭:AI自动化工作流拆解与实操复盘

不写代码也能搭:AI自动化工作流拆解与实操复盘

我一直觉得,很多非程序员朋友把“AI 自动化工作流”想成了只有工程师才能碰的东西。自己试过一轮之后我反而发现,搭一套能用的 AI 自动化工作流,最核心的难点根本不是写代码,而是怎么把手上那堆乱糟糟的活拆成一条清晰的任务流水线…

2026/10/14 7:24:38 阅读更多 →
游戏研发暑期实习笔试复盘:C++、图形学与算法建模全解析

游戏研发暑期实习笔试复盘:C++、图形学与算法建模全解析

2020年4月11日晚上19:00到21:30,我参加了某游戏大厂的游戏研发暑期实习笔试。2.5小时,没有休息,客观题加四道编程题,考到后面脑子确实有点发木。这不是我第一次接触游戏岗的笔试,但那场题覆盖面很典型,横跨…

2026/10/14 7:23:38 阅读更多 →

日新闻

AnyPS5通用适配层设计:兼容性与性能的工程取舍

AnyPS5通用适配层设计:兼容性与性能的工程取舍

1. 从"AnyPS5"这个名字说起:它到底想解决什么问题第一次看到"AnyPS5"这个标题,我脑子里冒出来的第一个念头是:这大概率是一个围绕"跨平台运行"或者"通用适配"做文章的项目。名字里的"Any"…

2026/10/14 0:00:41 阅读更多 →
Flutter跨平台开发实战:二手交易应用与HarmonyOS适配

Flutter跨平台开发实战:二手交易应用与HarmonyOS适配

1. 项目概述:Flutter跨平台二手交易应用开发作为一名长期从事移动应用开发的工程师,我最近完成了一个基于Flutter框架的二手物品交易平台项目。这个项目最吸引我的地方在于它完美结合了Flutter的跨平台优势与HarmonyOS的生态特性,实现了"…

2026/10/14 0:00:41 阅读更多 →
DFS算法解决飞机降落调度问题实战

DFS算法解决飞机降落调度问题实战

1. 项目背景与核心思路飞机降落问题是一个经典的调度优化场景,也是算法竞赛和面试中的高频题目。这个题目要求我们合理安排多架飞机的降落顺序和时间,确保所有飞机都能安全着陆而不发生冲突。在实际航空管制中,这类问题直接关系到飞行安全和机…

2026/10/14 0:00:41 阅读更多 →

周新闻

流感时间序列预测实战:ARIMA/LSTM全流程拆解与避坑指南

流感时间序列预测实战:ARIMA/LSTM全流程拆解与避坑指南

简介:基于 ARIMA、LSTM、Transformer 等模型的流感时间序列预测 Python 源码,面向计算机相关专业课程设计与期末大作业学生,以及项目实战学习者。内容覆盖预处理、平稳性检验、定阶、残差分析、多模型对比预测的完整时序建模流程,…

2026/10/14 3:30:28 阅读更多 →
影刀RPA新手教程:键盘模拟输入实战——输入文本与模拟按键的区别

影刀RPA新手教程:键盘模拟输入实战——输入文本与模拟按键的区别

影刀RPA新手教程:键盘模拟输入实战——输入文本与模拟按键的区别 做影刀RPA自动化,十个新手有八个栽在"往输入框里填东西"这件事上:要么填不进去,要么填了一半,要么直接把原来内容追加在后面。这背后的根因&…

2026/10/13 16:22:04 阅读更多 →
影刀RPA新手教程:阅文起点小说数据采集实战——书籍信息与章节内容

影刀RPA新手教程:阅文起点小说数据采集实战——书籍信息与章节内容

影刀RPA新手教程:阅文起点小说数据采集实战——书籍信息与章节内容 1. 认识影刀:什么场景该用RPA采小说数据 起点中文网的页面结构相对稳定——分类榜单、书籍详情、章节内容三块独立页面,跳转链路清晰。这种场景非常适合影刀自动化&#x…

2026/10/14 3:29:58 阅读更多 →

月新闻

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

我发现了一个新思路:用 Remotion + Claude Code 像写代码一样自动化生成短视频

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/13 22:01:27 阅读更多 →
Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

Windows下 Codex 中 Chrome 和 Computer Use 插件不可用问题排查及解决参考方式:TaoToken 统一 Key 配置与验证

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/13 14:57:39 阅读更多 →
黑夜航拍船只数据集训练YOLOV5模型全流程解析

黑夜航拍船只数据集训练YOLOV5模型全流程解析

/* MD / 富文本中的 .toc(含博客园搬家等嵌套结构);.toc-box 在侧栏,不受影响 */#content_views .toc,/* 编辑器常在目录前后插入空 p(:empty 仍占 20px),一并去掉避免顶空隙 */#content_views.markdown_views > p:empty:has(+ .toc),#content_views.markdown_views …

2026/10/12 18:11:17 阅读更多 →