热门

最新

红包

立Flag

投票

同城

我的

发布
gentelmantsao
GentlemanTsao
6 年前
truegentelmantsao

整洁代码(8):注释的善与恶

如果代码写的足够好,则注释纯属多余;

糟糕的代码需要大量注释补充说明。有趣的是,如果用代码表达的晦涩难懂,则注释往往也含糊不清。

即使注释一开始很准确,随着时间推移,代码不断演化,但是注释却少有人在维护,它过时了。
于是,过时的注释满口胡言。除了欺骗你、干扰你阅读代码,毫无用处。

有些注释是有用的,比如:
法律信息;
对返回值的提示;
警告提示;
TODO标识。

能用代码解释,又何必用注释

CSDN App 扫码分享
分享
评论
1
打赏
  • 复制链接
  • 举报
下一条:
大二.为啥想好好学习,思绪却如一团乱麻!生活像掉进了一个没有判断句的for循环,努力—>放弃->努力.......
立即登录