今天给大家带来一系列好玩的注释,希望大家能够喜欢!
很多人写代码总有这种习惯,一段代码不用了,注释掉,心里总想着这段代码以后可能还会用。但大多数情况下,过几天就忘了,结果代码里到处都是“注释”,没有一句是有用的。读代码的人也不敢删,一直留着留着。
我自己也是一名老程序员,今年用了一个多月整理了一份最适合2020年面试学习的Java面试干货知识点,技术内容包含有:Spring,Dubbo,MyBatis, RPC, MySQL数据结构与算法,源码分析,高并发、高性能、分布式,性能优化,微服务,高级架构开发等。
下面这个链接,暗号: csdn 。加入即可获得。
点这个,这个。
那么注释有什么用呢,我来给大家分析分析。
1、在类级别,方法级别上最好加上注释。
特别是那些逻辑复杂的,难以用一句话描述清楚的内容,最好加上注释,讲清楚这个类,或这个方法是用来干嘛的,有什么需要注意的地方。这个注释很重要,特别是这些代码还要被其他人使用的时候,加上说明会方便很多。
如来佛代码注释,保佑代码无BUG
/*
_ooOoo_
o8888888o
88" . "88
(| -_- |)
O\ = /O
____/`---'\____
.' \\| |// `.
/ \\||| : |||// \
/ _||||| -:- |||||- \
| | \\\ - /// | |
| \_| ''\---/'' | |
\ .-\__ `-` ___/-. /
___`. .' /--.--\ `. . __
."" '< `.___\_<|>_/___.' >'"".
| | : `- \`.;`\ _ /`;.`/ - ` : | |
\ \ `-. \_ __\ /__ _/ .-` / /
======`-.____`-.___\_____/___.-`____.-'======
`=---='
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
佛祖保佑 永无BUG
*/
这种地方很多时候是因为图省事,或者没时间等原因,只能暂时这么做,但是需要提醒使用者注意。或者怀疑队友水平没那么高,理解不了你的代码,某天来修改代码并且容易改错。或者是因为这段代码『特立独行』,不是按照常规方式,你自己在这里耍了小聪明,或者用了自己设计的一些技巧性的东西,怕别人看不懂。
/* 标准键盘布局
┌───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┐
│Esc│ │ F1│ F2│ F3│ F4│ │ F5│ F6│ F7│ F8│ │ F9│F10│F11│F12│ │P/S│S L│P/B│ ┌┐ ┌┐ ┌┐
└───┘ └───┴───┴───┴───┘ └───┴───┴───┴───┘ └───┴───┴───┴───┘ └───┴───┴───┘ └┘ └┘ └┘
┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌───┬───┬───┐ ┌───┬───┬───┬───┐
│~ `│! 1│@ 2│# 3│$ 4│% 5│^ 6│& 7│* 8│( 9│) 0│_ -│+ =│ BacSp │ │Ins│Hom│PUp│ │N L│ / │ * │ - │
├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├───┼───┼───┤ ├───┼───┼───┼───┤
│ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │{ [│} ]│ | \ │ │Del│End│PDn│ │ 7 │ 8 │ 9 │ │
├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ └───┴───┴───┘ ├───┼───┼───┤ + │
│ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │: ;│" '│ Enter │ │ 4 │ 5 │ 6 │ │
├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────────┤ ┌───┐ ├───┼───┼───┼───┤
│ Shift │ Z │ X │ C │ V │ B │ N │ M │< ,│> .│? /│ Shift │ │ ↑ │ │ 1 │ 2 │ 3 │ │
├─────┬──┴─┬─┴──┬┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤ ┌───┼───┼───┐ ├───┴───┼───┤ E││
│ Ctrl│ │Alt │ Space │ Alt│ │ │Ctrl│ │ ← │ ↓ │ → │ │ 0 │ . │←─┘│
└─────┴────┴────┴───────────────────────┴────┴────┴────┴────┘ └───┴───┴───┘ └───────┴───┴───┘
*/
3、涉及到业务逻辑的代码,比如某些字段需要加说明,之类的。
有些业务的东西,确实不是一两句代码就能扯清楚的,这种东西,加个注释就好了。
胜利手势代码注释
// d*##$.
// zP"""""$e. $" $o
//4$ '$ $" $
//'$ '$ J$ $F
// 'b $k $> $
// $k $r J$ d$
// '$ $ $" $~
// '$ "$ '$E $
// $ $L $" $F ...
// $. 4B $ $$$*"""*b
// '$ $. $$ $$ $F
// "$ R$ $F $" $
// $k ?$ u* dF .$
// ^$. $$" z$ u$$$$e
// #$b $E.dW@e$" ?$
// #$ .o$$# d$$$$c ?F
// $ .d$$#" . zo$> #$r .uF
// $L .u$*" $&$$$k .$$d$$F
// $$" ""^"$$$P"$P9$
// JP .o$$$$u:$P $$
// $ ..ue$" "" $"
// d$ $F $
// $$ ....udE 4B
// #$ """"` $r @$
// ^$L '$ $F
// RN 4N $
// *$b d$
// $$k $F
// $$b $F
// $"" $F
// '$ $
// $L $
// '$ $
// $ $
4.修改代码后,及时修改注释,并填写修改记录注释。
很多程序员在修改代码后由于时间关系,并不能及时修改注释,导致注释最后的注释完全错误。
围棋棋盘代码注释
// _______________________________________
// / ___________________________________ \
// _--""""--_ / /_/_/_/_/_|_|_|_|_|_|_|_|_|_\_\_\_\_\ \
// / \ / /_/_/_/_J__L_L_L_|_|_|_J_J_J__L_\_\_\_\ \
// /\ /\ / /_/_/_J__L_J__L_L_|_|_|_J_J__L_J__L_\_\_\ \
// L ""-____-"" J / /_/_J__L_J__L_J_J__L_|_J__L_L_J__L_J__L_\_\ \
// \ / / /_/__L_/__L_J__L_J__L_|_J__L_J__L_J__\_J__\_\ \
// \_ _/ / /_J__/_J__/__L_J__|__L_|_J__|__L_J__\__L_\__L_\ \
// _--"""""--_" / / F / F J J | F J | F J | F F J \ J \ \
// / \ / /--/-J--/--L--|--L-J--J--|--L--L-J--|--J--\--L-\--\ \
///\ /\ / /__/__L_J__J___L_J__J__|__|__|__L__L_J___L__L_J__\__\ \
//L ""-_____-"" J / / / / F F J J | | | | | F F J J \ \ \ \
//\ / / /--/--/--/--J---L--|--|--|--o--|--|--|--J---L--\--\--\--\ \
// \_ _/ / /__/__J__J___L__J___L__L__L__|__J__J__J___L__J___L__L__\__\ \
// "--___--" / / / F F J F J J F | J F F J F J J \ \ \
// / /--/---/--J---L--J---L--|--J---|---L--|--J---L--J---L--\---\--\ \
// / /__J___/___L__/___L__J___L__J___|___L__J___L__J___\__J___\___L__\ \
// / / F J / J J | J J | F F | F F \ F J \ \
// / /---/---L--J---L---L---L--|---|---|---|---|--J---J---J---L--J---\---\ \
// / /___/___/___L__J___J___J___|___|___|___|___|___L___L___L__J___\___\___\ \
// / / / / / F F F F F | J J J J J \ \ \ \ \
// / /___/___J___J___J___J___J____L___L___|___J___J____L___L___L___L___L___\___\ \
// / / / F F F | | J F | J F | | J J J \ \ \
// / /___J____/___/___J____L___L___|___J____|____L___|___J___J____L___\___\____L___\ \
// / / F / J F J J | J | F | F F J F \ J \ \
// / /____/___J____L___/____L___|____L___|____|____|___J____|___J____\___J____L___\____\ \
// / / / F / J J F J F | J F J F F \ J \ \ \
// / /____/____/___J____L____|____L___J____L____|____J____L___J____|____J____L___\____\____\ \
// / \
///_______________________________________________________________________________________________\
//| |
//| hs |
//|_______________________________________________________________________________________________|
5.代码及时review
电脑图像代码注释
/*
,----------------, ,---------,
,-----------------------, ," ,"|
," ,"| ," ," |
+-----------------------+ | ," ," |
| .-----------------. | | +---------+ |
| | | | | | -==----'| |
| | I LOVE DOS! | | | | | |
| | Bad command or | | |/----|`---= | |
| | C:\>_ | | | ,/|==== ooo | ;
| | | | | // |(((( [33]| ,"
| `-----------------' |," .;'| |(((( | ,"
+-----------------------+ ;; | | |,"
/_)______________(_/ //' | +---------+
___________________________/___ `,
/ oooooooooooooooo .o. oooo /, \,"-----------
/ ==ooooooooooooooo==.o. ooo= // ,`\--{)B ,"
/_==__==========__==_ooo__ooo=_/' /___________,"
*/
/*
6.对自己的代码带上责任感
只有这样才能让自己做一个优秀的程序员,大家一起共进步。
龙的图像代码注释
*/
/*
__----~~~~~~~~~~~------___
. . ~~//====...... __--~ ~~
-. \_|// |||\\ ~~~~~~::::... /~
___-==_ _-~o~ \/ ||| \\ _/~~-
__---~~~.==~||\=_ -_--~/_-~|- |\\ \\ _/~
_-~~ .=~ | \\-_ '-~7 /- / || \ /
.~ .~ | \\ -_ / /- / || \ /
/ ____ / | \\ ~-_/ /|- _/ .|| \ /
|~~ ~~|--~~~~--_ \ ~==-/ | \~--===~~ .\
' ~-| /| |-~\~~ __--~~
|-~~-_/ | | ~\_ _-~ /\
/ \ \__ \/~ \__
_--~ _/ | .-~~____--~-/ ~~==.
((->/~ '.|||' -_| ~~-/ , . _||
-_ ~\ ~~---l__i__i__i--~~_/
_-~-__ ~) \--______________--~~
//.-~~~-~_--~- |-------~~~~~~~~
//.-~~~--\
是不是很神奇很有趣,能把注释做到这种份上,恐怕也只有我们程序员可以这样做了。
有Java核心知识点+全套架构师学习资料和视频+一线大厂面试宝典+面试简历模板可以领取+阿里美团网易腾讯小米爱奇艺快手哔哩哔哩面试题+Spring源码合集+Java架构实战电子书。
下面这个链接,暗号: csdn 。加入即可获得。
点这个,这个。