本文共 2256 字,大约阅读时间需要 7 分钟。
世上本没有注释,垃圾代码写多了,也便有了注释。
注释仿佛与代码紧密相连,就像心有灵魂一样。
你会要求代码干净、整洁、优雅,虽然你自己都做不到这三点。
但从来没听过你要求注释要押韵,要是七言绝句,要形散而神不散。
编译器都会把注释忽略掉。
甚至有人说好的代码即是注释,你看,其实连人都不需要注释。
怎么了,是注释不配吗?
你明明忘了,刚开始学代码时,你能看懂的只有注释啊!
我职业生涯最大的挑战,不是看不懂代码,而是看不懂注释。
尤其是那些只有六个字的注释:“别动,后果自负”。
在单个函数超过一千行的臭名昭著代码和一天开发两天上线的傻话需求之前,能拯救我的只有注释。
没有注释,我只能骂娘。
但我不会骂娘,因为我会要求自己干净、整齐、优雅。
所以,即便是注释,我也要认真写,用中英日德法语写,甚至用设计模式写。
而今天,和大家分享一些有趣的注释。
也可参考
[注:以下为注释的艺术表现形式]
*** * .::::. * .::::::::. * ::::::::::: FUCK YOU * ..:::::::::::' * '::::::::::::' * .:::::::::: * '::::::::::::::.. * ..::::::::::::. * ``:::::::::::::::: * ::::``:::::::::' .:::. * ::::' ':::::' .::::::::. * .::::' :::: .:::::::'::::. * .:::' ::::: .:::::::::' ':::::. * .::' :::::.:::::::::' ':::::. * .::' ::::::::::::::' ``::::. * ...::: ::::::::::::' ``::. * ```` ':. ':::::::::' ::::.. * '.:::::' ':'````.. ***
**** http://www.freebuf.com/ * _.._ ,------------. * ,' `. ( We want you! ) * / __) __` \ `-,----------' * ( (`-`(-') ) _.-' * /) \ = / ( * /' |--' . \ * ( ,---| `-.)__` * )( `-.,--' _`-. * '/,' ( Uu", * (_ , `/,-' ) * `.__, : `-'/ /`--' * | `--' | * ` `-._ / * \ ( * /\ . \. freebuf * / |` \ ,-\ * / \| .) / \ * ( ,'|\ ,' : * | \,`.`--"/ } * `,' \ |,' / * / "-._ `-/ | * "-. "-.,'| ; * / _/["---'""] * : / |"- ' * ' | / * ` | ***
热衷于写注释的我,终于也快要放弃了。。。
编写注释从来都不是我的强项,但我也从未想过,自己会成为注释的忠实拥护者。
从最初的简单解释,到后来的深度阐述,注释成为了我职业生涯中不可或缺的一部分。
它不仅是代码的“心灵之声”,更是开发者的“心理寄托”。
在代码的迷宫中,注释是指引方向的灯塔;在功能的纷繁复杂中,注释是理解的桥梁。
而今天,我终于要向大家坦白,热衷于写注释的我,终于也快要放弃了。。。
或许,是因为我对注释的要求越来越高,想要让它们成为代码的灵魂,甚至用多种语言来表达自己的想法。
但在这个快节奏的开发环境中,写注释已经变得像是一项“负担”,它不仅占用了代码行数,更需要持续的维护和更新。
所以,虽然我的内心深处依然对注释充满热爱,但我也终于明白,注释不是终身的事业,只是职业生涯中的一段插曲。
从今以后,我会更加谨慎地对待注释,既不会过分追求注释的完美,也不会因为注释而耽误开发进度。
或许,这就是成长的代价。
转载地址:http://kusyz.baihongyu.com/