程序员 <http://www.yidianzixun.com/channel/w/%E7%A8%8B%E5%BA%8F%E5%91%98>最讨厌的事:

写注释 <http://www.yidianzixun.com/channel/w/%E6%B3%A8%E9%87%8A>、别人不写注释、别人写注释的字体和
编译器底色
<http://www.yidianzixun.com/channel/w/%E7%BC%96%E8%AF%91%E5%99%A8%E5%BA%95%E8%89%B2>
相同。

那么到底程序员该不该写注释?


其实对于写注释这件事来说,还是有一定的争议的,争议其实不在于该不该写注释,而是在于不要过多的写注释,注释多了,反而会让你感觉整个代码比较混乱不堪,影响视觉。而且有人为什么不太鼓励大家过多的去写注释呢?因为代码即注释,何为代码即注释?代码是具有自解释功能的。高质量,命名规范的代码,其实程序员一眼就能够看懂这段代码的功能作用。

今天小编就带大家看看什么叫做“教科书”版注释!



0.

//我写这一行的时候,只有上帝和我知道我在写什么

//现在,只有上帝知道了



1.

//somedev1 <http://www.yidianzixun.com/channel/w/somedev1> - 6/7/02
添加对登录屏幕的暂时追踪功能

// somedev2 - 5/22/07 暂时个屁

(仿佛看到两个程序员 <http://www.yidianzixun.com/channel/w/%E7%A8%8B%E5%BA%8F%E5%91%98>
相隔时空的diss)

2.

//喝大了,等会再修bug

3.

//有魔法,别碰。

4.

//开森地调bug吧,傻x

(隔着屏幕都想打他一顿)

5.





/*

*你可能觉得自己看懂下面的代码了,

*然而你并没有,相信我。

*糊弄过去算了,不然你会好多个晚上睡不着觉,

*嘴里骂着这段注释,觉得自己很聪明,

*真能“优化”下面的代码。

*现在关上文件,去玩点别的吧。

*/

6.

//这代码真是烂透了,你懂得,我也懂得。

7.

//先往下看,后面再喊我傻X。

8.

//我也不确定我们到底需不需要这个,但是删了又特害怕。

9.



#要想理解递归,移步本文件底部

然后翻到文件底部:

#要想理解递归,移步本文件顶部

10.

//本人对本代码概不负责,

//他们让我写的,非本人自愿。

11.

//就不给你们写注释

//这代码写得这么费劲

//所以你们读着也得费劲

12.

//如果这段代码跑的通,那就是Paul DiLascia写的。要是跑不通,

//那我就不知道是谁写的了

13.

//这公式没毛病,你要不信自己去算

14.

//要是你想被炒鱿鱼,那就删吧

15.

//如果将来读到这行代码,我会穿越回来,然后一死以谢天下。

16.

//谨以此代码和我所有的工作献给我的老婆Darlene <http://www.yidianzixun.com/channel/w/darlene>,

//这段代码要是放出去,

//她就得照顾我还有三个孩子了。

(潜台词是自己代码写的太烂,会丢了工作或者造成公司倒闭)

17.

//别删这行注释 <http://www.yidianzixun.com/channel/w/%E6%B3%A8%E9%87%8A>啊,删了程序就崩了


最后,如果有想一起学习web前端,HTML5及JavaScript的可以来一下我的前端群733581373,好友都会在里面交流,分享一些学习的方法和需要注意的小细节,每天也会准时的讲一些前端的炫酷特效,及前端直播课程学习

 



如果想看到更加系统的文章和学习方法经验可以关注的微信号:‘web前端技术圈’或者‘webxh6’关注后回复‘2018’可以领取一套完整的学习视频