连詹姆斯·高斯林（JAVA之父）都要被气疯掉的JAVA代码注释

前言

代码注释作为编程语言的“说明文档”，它的作用不容小觑。然而，现实的开发中出现了不少不重视代码注释的行为。比如不写注释又命名的不规范，让人看了一头雾水。又比如有些人利用代码注释开车，搞笑。对此，我想说，能不能有点创意？

• 科技系注释

/*** 
 * ┌───┐   ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┐
 * │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   │ . │←─┘│
 * └─────┴────┴────┴───────────────────────┴────┴────┴────┴────┘ └───┴───┴───┘ └───────┴───┴───┘
 */

• 佛系注释

 *             佛祖保佑             永无BUG 
 *                    _ooOoo_
 *                   o8888888o
 *                   88" . "88
 *                   (| -_- |)
 *                    O\ = /O
 *                ____/`---'\____
 *              .   ' \\| |// `.
 *               / \\||| : |||// \
 *             / _||||| -:- |||||- \
 *               | | \\\ - /// | |
 *             | \_| ''\---/'' | |
 *              \ .-\__ `-` ___/-. /
 *           ___`. .' /--.--\ `. . __
 *        ."" '< `.___\_<|>_/___.' >'"".
 *       | | : `- \`.;`\ _ /`;.`/ - ` : | |
 *         \ \ `-. \_ __\ /__ _/ .-` / /
 * ======`-.____`-.___\_____/___.-`____.-'======
 *                    `=---='
 *
 * .............................................
 *          佛祖保佑             永无BUG
 */

• 开车系注释

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

…

• 特么，你们能不能再有创意些？

---

作为一种编程语言，但JAVA本质上还是英文，所以，阅读代码就好比阅读一篇英文美文就越能证明编写者水平。因此，好的注释习惯必不可少。

• 类注释

/*
 * 【Author】 爱吃早餐的程序员
 * 【Time】2020年1月8日 下午5:07:25
 * 【Function】  这个是XXXX的接口
 */
public class KerryCall {
	  // private static SSLClient httpClient = null;
}

• 局部变量注释

  private static final int SocketTimeout = 5000; // 请求超时时间毫秒

• 方法注释

   /**
	    * 获取请求需要的token
	    * @param name  用户名
	    * @param appKey 密钥
	    * @param serverurl  地址
	    * @param order  订单
	    * @return
	    */
		public static Map<String, String> getToken(String name,String appKey,String serverurl) {
		// 略
｝

• 具体代码中的注释

		StringBuilder sb = new StringBuilder();
		sb.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
		sb.append("<SubmitOrder>");
		sb.append("<StoreLogin>"+"gmarket"+"</StoreLogin>");   //API用户名
		sb.append("<Token>"+token+"</Token>"); //UCS预先为您分配的授权码
		sb.append("<Carrier>FTZKR</Carrier>");
		sb.append("<UserID>jairus1</UserID>");   // 这个参数目前还不知道

• 最无语的注释

	 int i = 1000;  // 这里请求初始值为1000，客户使用费用基于1000 ，防止跟客户讨价还价，方便赚小费
     SecretKey key = kg.generateKey();

• 教导式的注释

/***
* 致终于来到这里的勇敢的人：
* 当你看到这段注释的时候，我已经离职了大概一个星期了......
* 你是被上帝选中的人，是英勇的、不敌辛苦的、不眠不休的来修改我们这最棘手的代码的编程骑士。
* 你，我们的救世主，人中之龙，我要对你说：永远不要放弃，永远不要对自己失望，永远不要逃走，辜负了自己，
* 永远不要哭啼，永远不要说再见，永远不要说谎来伤害自己。
* 这个公司没有年终奖的,兄弟别指望了,也别来了,我准备辞职了
* 另外这个项目有很多Bug 你坚持不了多久的,我先走一步了拜拜!
*/

       好了以上就是经常用到的注释类型，如何优雅的使用注释，大家都会了吗？