编写高质量代码改善C#程序的157个建议——建议152：最少，甚至是不要注释
2024-09-04 13:38:23
建议152：最少，甚至是不要注释
以往，我们在代码中不写上几行注释，就会被认为是钟不负责任的态度。现在，这种观点正在改变。试想，如果我们所有的命名全部采用有意义的单词或词组，注释还有多少存在的价值。
即便再详细的注释也不能优化糟糕的代码。并且注释往往不会随着代码的重构自动更新，有时候我们可能会在修改代码后忘记更新那段用来表达最初意图的文字了。所以，尽量抛弃注释吧，除非我们觉得只有良好的代码逻辑和命名仍旧不足以表达意图。
当然，有些注释可能不得不加，如一些版权信息。另外，如果我们正在开发公共API，保持一份良好的严格按照格式要求所写的注释有利于生成API参考手册。
当前有一种主张：不要写注释，或者尽量保持最少注释。
但前提是所有的命名全部采用有意义的单词或词组。
转自：《编写高质量代码改善C#程序的157个建议》陆敏技
最新文章
- 1-安装kvm及虚拟机
- tomcat7配置虚拟目录
- Centos 下面升级系统内核(转)
- HTTPD服务 openssl的https服务机制
- Java数组的--遍历
- 改变CSS样式
- VirtualBox 设置共享文件夹自动挂载
- React Native知识点
- CF 15/09/23
- C++：流类库与输入输出
- iOS下编译ffmpeg
- Linux apt-get error
- .net截取指定长度汉字超出部分以指定的字符代替
- MD5 32位、16位加密
- nodejs笔记2——请求路由
- 记一次-angular-数字格式化
- 由于 web 服务器上此资源的访问控制列表(acl)配置或加密设置，您无权查看此目录或页面。
- java语言中的匿名类与lambda表达式介绍与总结 (Anonymous Classes and Lambda Expressions)
- gdb分析core文件
- python 操作PostgreSQL