有关代码注释的神话

来源:百度文库 编辑:神马文学网 时间:2024/04/28 00:03:53
Jason Baker在一篇文章中列举了有关代码注释的种种神话:神话1:写代码注释是很自由的——实际上在你更新代码的同时需要更新注释;
神话2:注释让代码变得更可读——此神话无处不在,但多数情况下注释让代码变得难以阅读;
神话3:你应该为每一个函数、方法、类以及模块写注释——给不需要注释的东西写注释通常都是糟糕的主意;
神话4:代码必须始终能“自我文档化”——所谓此消彼长,你到底喜欢写一行代码带三行注释,还是写十行代码但没有注释?