有关代码注释的神话

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

请勿发布不友善或者负能量的内容。与人为善,比聪明更重要!

留言需要登陆哦

技术博客集 - 网站简介:
前后端技术:
后端基于Hyperf2.1框架开发,前端使用Bootstrap可视化布局系统生成

网站主要作用:
1.编程技术分享及讨论交流,内置聊天系统;
2.测试交流框架问题,比如:Hyperf、Laravel、TP、beego;
3.本站数据是基于大数据采集等爬虫技术为基础助力分享知识,如有侵权请发邮件到站长邮箱,站长会尽快处理;
4.站长邮箱:[email protected];

      订阅博客周刊 去订阅

文章归档

文章标签

友情链接

Auther ·HouTiZong
侯体宗的博客
© 2020 zongscan.com
版权所有ICP证 : 粤ICP备20027696号
PHP交流群 也可以扫右边的二维码
侯体宗的博客