代码神注释,让我们认真对待一次!

兄弟,请你冷静的听我扯淡,别动手!有本事点个关注再走,【对,就点这儿】


文末会附上几个可以直接复制使用的注释模板,更多请点末尾提到的链接。

前两天我在朋友圈看到有个人在说:“好的代码是可以自己解释自己的,所以我从来不写注释”。

小伙子,你这么装 B,你家里人知道吗?不怕扯着蛋么?

不过对于这样装 B 的年轻人,老马我只想喂他吃 10 万行 the fucking source code。让他好好体会一下没有注释看别人代码时那种酸爽的感觉!

嗯,都说见不得别人装 B 的人,其实只是见不得别人装的比自己装的厉害!咳咳....怎么能这么说呢?不过....到是....蛮有道理的,hou~

不过单从装 B 的角度来讲,我想说:“小伙子,你还是 too young to simple 了,这样难免显得有些稚嫩了。”

以我老马混迹江湖多年的经验来看,代码不仅要有注释。而且像我们这种追求代码质(zhuang)量(B)的人,还必须要配上高(gou)质(zhuang)量(B)的注释,那样才符合我们的身份呀!

言归正传,究竟怎么编写注释才能体现身份呢?先给大家推荐一个网站,点击【这里】可以跳转(这网站一定是个有情怀的程序猿才能开发出来的)。

有了这个网站
我的注释变成了这样的风格
我佛镇楼!保代码永无 Bug

在代码里向妹子表个白?
你们部门里没有妹子怎么办?
男的总有吧!?
额...你要搞基也用得着!

我是一匹来自北方的狼
你们谁懂我心理的伤

代码、代码!
你可以禁锢我的身
但禁锢不了我向往蓝天的心

我害羞,看不见
这两个人是要做啥?

啊.....你写的代码....
有毒!!

跟我一起唱!
啊~
五环~你比四环多一环

又或者你想讲个故事










嗯,这是一个悲伤的故事
我相信看了这样的注释
你一定会说
“计划生育不让生这么多!”
我这么努力煽情,你TM在逗我?

看来是时候来一波福利了
(懒得复制到IDE里了)





其实这些都是小伎俩,估计老司机们都玩腻了。可能你之前只是看过,但不知道这些都是怎么来的。那现在你也可以随便找几个来装 B 一下了。如果以后和你协作的人,还有给你说注释不重要的,那你直接在代码里给他注释一坨 xiang。冒热气的那种!

对了!有一点需要注意的是,这个网站上的注释并不是直接复制过来就可以用的,否则排版会乱掉的。必须先复制到记事本中,并在每行前添加一个 * 号,然后在复制粘贴到 **块注释 **中就可以了。

像我上面说的,装 B 的人见不得别人装的比自己厉害,所以肯定会有人说:“你这么注释一点也不实用!”拜托,我说实用了么?我从一开始说的就是装 B 啊。装 B 的东西有实用的么?!

代码不易,且敲且装 B
—— By 老马

最后附上几个可以直接复制使用的注释模板。查看更多请点这里:【点我看更多】

/**
 *                 _._  ,mm_            =._
 *            ,m############m.      .-===-==--.._
 *          ,m#8888##88###88##m    --=.=--========-
 *         m#888#####888###888#m  /--'==----==-====`.
 *        ##88######8888####88#m |--'==------=--====`
 *        ###888###88888####88## |=|=====----==--====|
 *        ###########88## ###### `=|==.========---===|
 *        ##############" #####"  \=\=|\=/,=====--===|
 *        "######"~ ~=_'_,~ m#"    `.|>|/,=//===-===/
 *         "##( Y \_ "~'__/~'      .-||, ~'/,,=-====|
 *          (m#m_#m ~~' , `        | |    '~/======|'
 * marno    m# "#>#m    - 'm.       \|     _~'====|/
 *         ###  , "#m __.'"#m`.      |    / \====,'
 *         ###m_' `##m     "#m `    ,'  -|   `"=\
 *         "#'  `. `##`     "#m    '   ' |   |  =\
 *          '     `-##`     #"   ,'   '  |--.`   =|
 *         |         ~~-_      ,'    '  /~    .  =|
 *         |             ~-. _-     '  /      `. |=\
 *         |   ~~-.         ~      ' .'        ` \=/
 *         `       ~-.           ,'.~  '    '   |
 *          .     |   ~~-..__  _,',   .    .    |
 *          `      `.__.' _/ ~~  |    '    '    '
 *           .           .'       \  .    :    /
 *           `
 */
/**
 *                                     _
 *                                    (  )
 *     _ .                         ( `  ) . )
 *   (  _ )_                      (_, _(  ,_)_)
 * (_  _(_ ,)
 *                                                       |
 *         _  _                                        \ _ /
 *        ( `   )_                                   -= (_) =-
 *       (    )    `)                                  /   \
 *     (_   (_ .  _) _)                                  |
 *
 *                                _
 *                              -=\`\
 *                          |\ ____\_\__
 *                        -=\c`""""""" "`)
 *                           `~~~~~/ /~~`
 *                             -==/ /
 *                               '-'                 _
 *                                                  (  )
 *                _, _ .                         ( `  ) . )
 *               ( (  _ )_                      (_, _(  ,_)_)
 *      marno  (_(_  _(_ ,)
 */

/**
 *
 *          ,g  8b ,g                 ,g        8g   8g
 *      o8888"  88 Y8     .od888888888P"       88'  88'
 *        88    88 "        88  88  88        88'  88888888b
 *    8888888888888888   d88888888888888b    888  88  oo  88
 *        88    88       88    88      88   8'88 8'   88  P'
 *        88,o  88 o9,     888888888888       88    8 88
 *        88P   88,8P         88              88   o8 88 g
 *      ,888    888'         88888888b        88   8' 88 `8,
 *     d8'88   g88          88 gg ,88'        88  ,P  88  8b
 *     8' 88 oP 88,        d8' `g88'          88  8   88  `P
 *        88    `88 g     o8'  gg88b,         88 f    88
 *       d8'      `b'    o8  oP'   "Y8ao      88     d8'       I love you
 */

/**
 *                 uuuuuuu
 *             uu$$$$$$$$$$$uu
 *          uu$$$$$$$$$$$$$$$$$uu
 *         u$$$$$$$$$$$$$$$$$$$$$u
 *        u$$$$$$$$$$$$$$$$$$$$$$$u
 *       u$$$$$$$$$$$$$$$$$$$$$$$$$u
 *       u$$$$$$$$$$$$$$$$$$$$$$$$$u
 *       u$$$$$$"   "$$$"   "$$$$$$u
 *       "$$$$"      u$u       $$$$"
 *        $$$u       u$u       u$$$
 *        $$$u      u$$$u      u$$$
 *         "$$$$uu$$$   $$$uu$$$$"
 *          "$$$$$$$"   "$$$$$$$"
 *            u$$$$$$$u$$$$$$$u
 *             u$"$"$"$"$"$"$u
 *  uuu        $$u$ $ $ $ $u$$       uuu
 * u$$$$        $$$$$u$u$u$$$       u$$$$
 *  $$$$$uu      "$$$$$$$$$"     uu$$$$$$
 *u$$$$$$$$$$$uu    """""    uuuu$$$$$$$$$$
 *$$$$"""$$$$$$$$$$uuu   uu$$$$$$$$$"""$$$"
 * """      ""$$$$$$MARNOuu ""$"""
 *           uuuu ""$$$$$$$$$$uuu
 *  u$$$uuu$$$$$$$$$uu ""$$$$$$$$$$$uuu$$$
 *  $$$$$$$$$$""""           ""$$$$$$$$$$$"
 *   "$$$$$"                      ""$$$$""
 *     $$$"                         $$$$"
 */
/**
 *
 *     _.-"""""-._         _.-"""""-._         _.-"""""-._
 *   ,'           `.     ,'           `.     ,'           `.
 *  /               \   /               \   /               \
 * |                 | |                 | |                 |
 *|                   |                   |                   |
 *|                   |                   |                   |
 * |             _.-"|"|"-._         _.-"|"|"-._             |
 *  \          ,'   /   \   `.     ,'   /   \   `.          /
 *   `.       /   ,'     `.   \   /   ,'     `.   \       ,'
 *     `-..__|..-'         `-..|_|..-'         `-..|__..-'
 *          |                   |                   |
 *          |                   |                   |
 *           |                 | |                 |
 *            \               /   \               /
 *             `.           ,'     `.           ,'
 *               `-..___..-'         `-..___..-'
 *
 */
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,126评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,254评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,445评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,185评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,178评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,970评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,276评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,927评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,400评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,883评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,997评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,646评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,213评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,204评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,423评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,423评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,722评论 2 345

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,498评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 泉甘为谁甜, 非卿本无缘。 先行觅知音, 生余伴红颜。 真情守初心, 爱意总无边。 合欢树下走, 欢乐留心间。 谢...
    何时再出发阅读 250评论 2 0
  • 扬鞭奋蹄,人人都以为自己是马背上那个,实际我们都在被鞭子抽打着,或向前,或趴泥,或一蹶不振。催着赶着生活才不一样了...
    静听l风吟阅读 132评论 0 0
  • 想记录下昨天的三个人两件事。 第一位,“我一定要保本,给我推荐个理财”,我:“喔,那我先问问您之前都做过...
    老孙家的老四阅读 221评论 0 2