关于代码注释的思考
书本上的理论以前的笔记里还记着这些理论呢。《重构-改善既有代码的设计》任何一个傻瓜都能写出计算机可以理解的代码唯有写出人类容易理解的代码才是优秀的程序员。《代码整洁之道》上的言论什么是整洁的代码1.我喜欢优雅和高效的代码。代码逻辑应当直截了当令缺陷难以隐藏尽量减少依赖关系使之便于维护依据某种分层战略完善错误处理代码性能调至最优省得引诱别人做没规矩的优化搞出一些混乱来。整洁的代码只做好一件事。2.整洁的代码简单直接。整洁的代码如同优美的散文。整洁的代码从不隐藏设计者的意图充满了干净利落的抽象和直截了当的控制语句。3.整洁的代码总是看起来像是某位特别在意它的人写的。几乎没有改进的余地。4.如果每个例程都让你感到深合己意那就是整洁代码。如果代码让编程语言看起来是专为解决那个问题而存在的就可以称之为漂亮的代码。有意义的命名变量、函数或类的名称应该已经答复了所有的大问题。它该告诉你它为什么存在、它做什么事、应该怎么用。如果名称需要用注释来补充那就不算是名副其实。以前看这些东西看的是津津有味觉得说的很对。包括以前的公司也宣传这种规范说起变量名之前要思考一下尽量少些注释。国内的实际情况关于前面提到的书籍上的规范性理论我的体会是这些书都是外国人写的编程语言是他们发明的他们的母语也是英语所以他们在写代码的时候追求代码的强语义性的收益很高不管用啥单词他们一看就懂再考虑下命名与业务的契合度就很完美他们看代码那真就像看”散文“一样了。但是国内的实际情况是什么开发人员写代码碰到不知道怎么命名的单词都是随手翻译一下就写上去了不管这单词认不认识或者生僻与否还有很多拼写错误也不纠正再加上代码逻辑不够清晰的话那给人的阅读体验当然不好那什么“山”就来了。再说说有些公司为什么提倡不写注释要用命名体现意图。这些都是老一辈程序员有情怀且带的都是小团队而且业务语言和开发语言都比较统一所以代码名字写准确了基本就能很好的理解业务。但是大公司就不行了一个组十几个人时间紧任务重有些领导甚至没时间review代码或者根本不在乎你写的啥功能实现就行了所以也没人在乎这些规范了。加上张三的任务李四也不一定了解再不写点注释那接手的人痛苦至极。总结所以必要时要尽量多写的代码注释把逻辑描述清楚利己利人。当然这并不意味着可以随便命名了。注释要能帮助梳理整体逻辑必要的不能省不能自我感觉良好看着自己的干净的代码心里美滋滋也许很快就忘了。非必要时就不要写注释了有的人可能待过特殊的公司每一行代码都写注释像什么list.get(0)true或者false都写个注释那也实在没必要。最后我觉得阿里开发手册里关于注释规范说的挺好贴一下

相关新闻

蒙特卡洛离策略强化学习:工业级实操指南

蒙特卡洛离策略强化学习:工业级实操指南

1. 这不是教科书里的“蒙特卡洛离策略”——而是一线强化学习工程师每天真正在调的那套东西“Monte Carlo Off-Policy Explained”这个标题,乍看像一篇理论综述,但如果你真在做机器人控制、广告出价系统、金融交易策略或游戏AI,就会立刻意识到…

2026/6/25 23:07:07阅读更多 →
终极暗黑2存档编辑器:免费网页版角色修改完全指南

终极暗黑2存档编辑器:免费网页版角色修改完全指南

终极暗黑2存档编辑器:免费网页版角色修改完全指南 【免费下载链接】d2s-editor 项目地址: https://gitcode.com/gh_mirrors/d2/d2s-editor 你是否厌倦了重复练级,想要在暗黑破坏神2中快速测试不同的角色build?这款暗黑2存档编辑器正是…

2026/6/25 23:07:07阅读更多 →
3步修复老Mac显卡驱动:OCLP终极优化指南

3步修复老Mac显卡驱动:OCLP终极优化指南

3步修复老Mac显卡驱动:OCLP终极优化指南 【免费下载链接】OpenCore-Legacy-Patcher Experience macOS just like before 项目地址: https://gitcode.com/GitHub_Trending/op/OpenCore-Legacy-Patcher 你是否遇到过这样的场景:将心爱的老Mac升级到…

2026/6/25 23:07:07阅读更多 →
教育系统漏洞挖掘实战:从信息收集到SRC报告的全流程指南

教育系统漏洞挖掘实战:从信息收集到SRC报告的全流程指南

1. 项目概述:一次针对特定教育管理系统的安全探索最近在和一些做安全研究的朋友交流时,聊到了一个挺有意思的方向:针对特定行业应用系统的漏洞挖掘。这类系统往往因为其应用场景的封闭性和用户群体的特殊性,在安全设计上可能存在一…

2026/6/26 0:22:18阅读更多 →
MTKClient终极指南:5步掌握联发科设备底层控制的完整解决方案

MTKClient终极指南:5步掌握联发科设备底层控制的完整解决方案

MTKClient终极指南:5步掌握联发科设备底层控制的完整解决方案 【免费下载链接】mtkclient MTK reverse engineering and flash tool 项目地址: https://gitcode.com/gh_mirrors/mt/mtkclient 想要完全掌控你的联发科设备吗?MTKClient这款强大的联…

2026/6/26 0:22:18阅读更多 →
【JAVA毕设源码分享】基于JAVA的某企业员工考试系统的设计与实现(程序+文档+代码讲解+一条龙定制)

【JAVA毕设源码分享】基于JAVA的某企业员工考试系统的设计与实现(程序+文档+代码讲解+一条龙定制)

博主介绍:✌️码农一枚 ,专注于大学生项目实战开发、讲解和毕业🚢文撰写修改等。全栈领域优质创作者,博客之星、掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java、小程序技术领域和毕业项目实战 ✌️技术范围:&am…

2026/6/26 0:22:18阅读更多 →
免费开源虚拟桌面伴侣:5分钟打造你的专属二次元伙伴

免费开源虚拟桌面伴侣:5分钟打造你的专属二次元伙伴

免费开源虚拟桌面伴侣:5分钟打造你的专属二次元伙伴 【免费下载链接】Mate-Engine A free Desktop Mate alternative with a lightweight interface and custom VRM support, though with more features. 项目地址: https://gitcode.com/gh_mirrors/ma/Mate-Engin…

2026/6/26 0:22:18阅读更多 →
说说防跌倒动作训练

说说防跌倒动作训练

1、扶椅单腿站双手轻扶椅背,抬起左脚离地10厘米,保持10秒至15秒,放下,换右腿进行练习。该动作锻炼平衡力,可以站稳再松手。2、坐姿抬小腿坐在椅子上,腰背挺直,缓慢抬起右小腿至与地面平行&#…

2026/6/26 0:22:18阅读更多 →
【毕业设计】基于 SpringBoot 的校园学术论坛交流管理系统设计与实现 面向高校师生的学术交流服务平台设计与实现(源码+文档+远程调试,全bao定制等)

【毕业设计】基于 SpringBoot 的校园学术论坛交流管理系统设计与实现 面向高校师生的学术交流服务平台设计与实现(源码+文档+远程调试,全bao定制等)

博主介绍:✌️码农一枚 ,专注于大学生项目实战开发、讲解和毕业🚢文撰写修改等。全栈领域优质创作者,博客之星、掘金/华为云/阿里云/InfoQ等平台优质作者、专注于Java、小程序技术领域和毕业项目实战 ✌️技术范围:&am…

2026/6/26 0:17:18阅读更多 →
【人工智能】一文搞定到底什么是智能体

【人工智能】一文搞定到底什么是智能体

【人工智能】一文搞定到底什么是智能体 一文搞定到底什么是智能体【人工智能】一文搞定到底什么是智能体一. LM,WorkFlow,Agent分别有什么么不同二. Agent的思考过程是怎样的三. Agent的五个核心部分1)LLM2)Prompt3)Me…

2026/6/25 9:39:54阅读更多 →
嵌入式GUI控件实战:ROTARY、SCROLLBAR、SLIDER原理与应用

嵌入式GUI控件实战:ROTARY、SCROLLBAR、SLIDER原理与应用

1. 嵌入式GUI控件:从原理到实战的深度解析在嵌入式系统开发中,图形用户界面(GUI)的设计与实现往往是项目从“能用”到“好用”的关键一跃。不同于资源充沛的PC或移动平台,嵌入式设备的GUI需要在有限的CPU性能、内存空间…

2026/6/25 2:52:24阅读更多 →
Google AI Studio 300美元额度的真相与实战指南

Google AI Studio 300美元额度的真相与实战指南

1. 这300美金不是“送钱”,而是Google埋下的第一道技术门槛 你看到标题里那个醒目的“$300美金”时,第一反应可能是:又一个免费额度?领完就完事?我亲手试过——这300美金根本不是红包,而是一张入场券&…

2026/6/25 9:01:34阅读更多 →
HPE (慧与) 服务器专用 ESXi 9 全套官方定制资源详解 + 完整部署升级教程

HPE (慧与) 服务器专用 ESXi 9 全套官方定制资源详解 + 完整部署升级教程

一、前言:企业运维痛点与资源价值自博通收购 VMware 之后,原 VMware 公开免费下载渠道全面关闭,企业运维人员想要获取适配 HPE 慧与服务器的 ESXi 9 原厂镜像,必须注册博通账号、绑定有效授权才能下载,无授权账号无法获…

2026/6/26 0:02:15阅读更多 →
Kotlin的@JvmStatic与@JvmField:与Java互操作的注解

Kotlin的@JvmStatic与@JvmField:与Java互操作的注解

Kotlin作为一门现代编程语言,与Java的互操作性一直是其核心优势之一。为了让Kotlin代码能够无缝对接Java,Kotlin提供了多种注解来优化互操作体验,其中JvmStatic和JvmField是两个关键注解。它们分别用于解决静态成员和字段在Java中的访问问题&…

2026/6/26 0:02:15阅读更多 →
深入解析musl libc中的mmap实现源码

深入解析musl libc中的mmap实现源码

最近在阅读musl libc源码时,发现其mmap的实现非常精妙,特分享给大家。 一、代码整体结构 这段代码实现了__mmap函数,并通过weak_alias导出为mmap。这是典型的musl libc风格——提供弱符号以便用户可以重写。 weak_alias(__mmap, mmap); 二…

2026/6/26 0:02:15阅读更多 →