编写高质量代码改善C#程序的157个建议——建议152:最少,甚至是不要注释
2015-08-24 08:41
417 查看
建议152:最少,甚至是不要注释
以往,我们在代码中不写上几行注释,就会被认为是钟不负责任的态度。现在,这种观点正在改变。试想,如果我们所有的命名全部采用有意义的单词或词组,注释还有多少存在的价值。
即便再详细的注释也不能优化糟糕的代码。并且注释往往不会随着代码的重构自动更新,有时候我们可能会在修改代码后忘记更新那段用来表达最初意图的文字了。所以,尽量抛弃注释吧,除非我们觉得只有良好的代码逻辑和命名仍旧不足以表达意图。
当然,有些注释可能不得不加,如一些版权信息。另外,如果我们正在开发公共API,保持一份良好的严格按照格式要求所写的注释有利于生成API参考手册。
当前有一种主张:不要写注释,或者尽量保持最少注释。
但前提是所有的命名全部采用有意义的单词或词组。
转自:《编写高质量代码改善C#程序的157个建议》陆敏技
以往,我们在代码中不写上几行注释,就会被认为是钟不负责任的态度。现在,这种观点正在改变。试想,如果我们所有的命名全部采用有意义的单词或词组,注释还有多少存在的价值。
即便再详细的注释也不能优化糟糕的代码。并且注释往往不会随着代码的重构自动更新,有时候我们可能会在修改代码后忘记更新那段用来表达最初意图的文字了。所以,尽量抛弃注释吧,除非我们觉得只有良好的代码逻辑和命名仍旧不足以表达意图。
当然,有些注释可能不得不加,如一些版权信息。另外,如果我们正在开发公共API,保持一份良好的严格按照格式要求所写的注释有利于生成API参考手册。
当前有一种主张:不要写注释,或者尽量保持最少注释。
但前提是所有的命名全部采用有意义的单词或词组。
转自:《编写高质量代码改善C#程序的157个建议》陆敏技
相关文章推荐
- 编写高质量代码改善C#程序的157个建议——建议151:使用事件访问器替换公开的事件成员变量
- 编写高质量代码改善C#程序的157个建议——建议150:使用匿名方法、Lambda表达式代替方法
- 编写高质量代码改善C#程序的157个建议——建议149:使用表驱动法避免过长的if和switch分支
- C#事件
- 编写高质量代码改善C#程序的157个建议——建议148:不重复代码
- 编写高质量代码改善C#程序的157个建议——建议147:重构多个相关属性为一个类
- 编写高质量代码改善C#程序的157个建议——建议146:只对外公布必要的操作
- 编写高质量代码改善C#程序的157个建议——建议145:避免过长的方法和过长的类
- 编写高质量代码改善C#程序的157个建议——建议144:一个方法只做一件事
- c# 实现类似skynet的核心库
- c#读取Execl表格数据
- 编写高质量代码改善C#程序的157个建议——建议143:方法抽象级别应在同一层次
- C# String.Format字符串中包含"{" "}"时需注意的问题
- C#使用DirectShow实现简单的视频播放
- 编写高质量代码改善C#程序的157个建议——建议142:总是提供有意义的命名
- 【C#】事务
- c# Socket 开发小记
- C#基础------方法
- C# 之 FTP服务器中文件上传与下载(二)
- 编写高质量代码改善C#程序的157个建议——建议141:不知道该不该用大括号时,就用