兄弟,请你冷静的听我扯淡,别动手!有本事点个关注再走,【对,就点这儿】
文末会附上几个可以直接复制使用的注释模板,更多请点末尾提到的链接。
前两天我在朋友圈看到有个人在说:“好的代码是可以自己解释自己的,所以我从来不写注释”。
小伙子,你这么装 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$$$
* $$$$$$$$$$"""" ""$$$$$$$$$$$"
* "$$$$$" ""$$$$""
* $$$" $$$$"
*/
/**
*
* _.-"""""-._ _.-"""""-._ _.-"""""-._
* ,' `. ,' `. ,' `.
* / \ / \ / \
* | | | | | |
*| | | |
*| | | |
* | _.-"|"|"-._ _.-"|"|"-._ |
* \ ,' / \ `. ,' / \ `. /
* `. / ,' `. \ / ,' `. \ ,'
* `-..__|..-' `-..|_|..-' `-..|__..-'
* | | |
* | | |
* | | | |
* \ / \ /
* `. ,' `. ,'
* `-..___..-' `-..___..-'
*
*/