查看原文
其他

注释,今晚我不关心代码,我只想你

特立独行的分享 前端试炼 2022-05-12

世上本没有注释,垃圾代码写多了,也便有了注释。

注释仿佛是依赖于代码存在的。

你会要求代码干净,整洁,优雅,虽然你自己都做不到这三点。

但是从来没听过你要求注释要押韵,要是七言绝句,要形散而神不散。

编译器,都会把注释忽略掉。

甚至有人说好的代码即是注释,你看,其实连人都不需要注释。

即便面试吹逼,你也不会说自己喜欢写注释。

怎么了,是注释不配吗?

你明明忘了,刚开始学代码时,你能看懂的只有注释啊!

我职业生涯最大的挑战,不是看不懂代码,而且看不懂注释。

尤其注释只有六个字:“别动,后果自负”。

在单个函数超过一千行屎山代码和一天开发两天上线的傻X需求之前,能拯救我的只有注释。

没有注释,我只能骂娘。

但我不会骂娘,因为我会要求自己干净,整齐,优雅。

所以,即便是注释,我也要认真写,用中英日德法语写,重构着写,甚至用设计模式写。

而今天,和大家分享一些有趣的注释。

也可参考 https://github.com/Blankj/awesome-comment

/***
 *                    .::::.
 *                  .::::::::.
 *                 :::::::::::  FUCK YOU
 *             ..:::::::::::'
 *           '::::::::::::'
 *             .::::::::::
 *        '::::::::::::::..
 *             ..::::::::::::.
 *           ``::::::::::::::::
 *            ::::``:::::::::'        .:::.
 *           ::::'   ':::::'       .::::::::.
 *         .::::'      ::::     .:::::::'::::.
 *        .:::'       :::::  .:::::::::' ':::::.
 *       .::'        :::::.:::::::::'      ':::::.
 *      .::'         ::::::::::::::'         ``::::.
 *  ...:::           ::::::::::::'              ``::.
 * ```` ':.          ':::::::::'                  ::::..
 *                    '.:::::'                    ':'````..
 */

/***
 * http://www.freebuf.com/
 *           _.._        ,------------.
 *        ,'      `.    ( We want you! )
 *       /  __) __` \    `-,----------'
 *      (  (`-`(-')  ) _.-'
 *      /)  \  = /  (
 *     /'    |--' .  \
 *    (  ,---|  `-.)__`
 *     )(  `-.,--'   _`-.
 *    '/,'          (  Uu",
 *     (_       ,    `/,-' )
 *     `.__,  : `-'/  /`--'
 *       |     `--'  |
 *       `   `-._   /
 *        \        (
 *        /\ .      \.  freebuf
 *       / |` \     ,-\
 *      /  \| .)   /   \
 *     ( ,'|\    ,'     :
 *     | \,`.`--"/      }
 *     `,'    \  |,'    /
 *    / "-._   `-/      |
 *    "-.   "-.,'|     ;
 *   /        _/["---'""]
 *  :        /  |"-     '
 *  '           |      /
 *              `      |
 */


/***
 * TODO 下一个版本优化这里
 * TODO 产品经理跑路了,所以我已经忘了要优化什么了,祝好运。
 * FUCK
 */


// 此处有坑
// 此处一定要sleep 10 秒,客户才能给钱优化,并且效果明显。
昕霖产品经理, 李超设计师.
// 昕霖要圆角
// 李超要直角
// 策划第一次修改需求。时间 ********
// 策划第二次修改需求。时间 ********
// 策划第三次修改需求。时间 ********
//cao f**k。时间 ********
// 请不要随意吐槽命名,产品定的。
// 找不到爸爸,儿子组件置空 ,重新请求
// github 抄的这段代码,我也没看懂,先用了。
/***
 * 这个公司没有年终奖的,兄弟别指望了,也别来了,我准备辞职了
 * 另外这个项目有很多*Bug* 你坚持不了多久的,拜拜!
 */

/***
 * 你可能会认为你读得懂以下的代码。但是你不会懂的,相信我吧。
 * 要是你尝试玩弄这段代码的话,你将会在无尽的通宵中不断地咒骂自己为什么会认为自己聪明到可以优化这段代码。
 * 现在请关闭这个文件去玩点别的吧。
 */

/***
 * somedev1 -  6/7/02 Adding temporary tracking of Login screen
 * somedev2 -  5/22/07 Temporary my ass
 */

/***
 * 一些修改1 - 2002/6/7 增加临时的跟踪登录界面
 * 一些修改2 - 2007/5/22 我临时的犯傻
 */

/***
 * 程序员1(于2010年6月7日):在这个坑临时加入一些调料
 * 程序员2(于2011年5月22日):临你个屁啊
 * 程序员3(于2012年7月23日):楼上都是狗屎,鉴定完毕
 * 程序员4(于2013年8月2日):fuck 楼上,三年了,这坑还在!!!
 * 程序员5(于2014年8月21日):哈哈哈,这坑居然坑了这么多人,幸好我也不用填了,系统终止运行了,you're died
 */

/*** 
 * 致终于来到这里的勇敢的人:
 * 你是被上帝选中的人,是英勇的、不敌辛苦的、不眠不休的来修改我们这最棘手的代码的编程骑士。
 * 你,我们的救世主,人中之龙,我要对你说:永远不要放弃,永远不要对自己失望,永远不要逃走,辜负了自己,
 * 永远不要哭啼,永远不要说再见,永远不要说谎来伤害自己。
 */


/***
 * 亲爱的维护者:
 *
 * 如果你尝试了对这段程序进行'优化'
 * 下面这个计数器的个数用来对后来人进行警告
 *
 * 浪费在这里的总时间 = 42h
 */

/***
* 写这段代码的时候,只有上帝和我知道它是干嘛的
* 现在,只有上帝知道
*/

// 有点晕了,以后再修改
#define TRUE FALSE 
// 这样可以更加愉快的调试bug了!

<!-- 前方代码高能预警 -->
// 自行了解,不方便解释
// 想要明白递归须看文件末尾
到了文末
// 想要明白递归须看文件顶部
// 你我都知道这代码很烂
// 但是请先不要骂我SB了,请先继续往下看
// 虽然我不知道为什么这样管用,但它却是修复了问题
// 如果删了此处注释程序就炸了
// 这函数1987年就这在了,谁都别动它!
// 难写的代码,肯定很难读。因此,我没有注释留给你。
//* 你绝对看不懂的 */
// 看来我得准备简历了
/***
 * 这个类是Object的子类
 */

/***
 * 如果这些代码有用,那它们是我写的,如果没用,那我就不知道是谁写的了。
 */


应该是游戏里面的注释
/***
 * z = -z //虽然不知道为什么但是敌人终于头朝上了。
 */



热衷于写注释的我,终于也快要放弃了。。。

交流讨论

欢迎关注公众号「前端试炼」,公众号平时会分享一些实用或者有意思的东西,发现代码之美。专注深度和最佳实践,希望打造一个高质量的公众号。

❤️ 

公众号后台回复【小炼】

邀请你加入纯净技术交流群(上班划水摸鱼群)

🙏

如果觉得这篇文章还不错

来个【分享、点赞、在看】三连吧

让更多的人也看到


您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存