软件编码规范（未完待续）

一 注释

1 类注释

1.1 示例

/**
* @className: DrugClassDict
* @description: 药品分类字典表
* @date: 2020/10/12
* @author: chengqiuming
*/
@Entity
@Table
public class DrugClassDict implements java.io.Serializable {
}

1.2 模板

/**
* @className: $name$
* @description: TODO
* @date: $date$
* @author: chengqiuming
*/

1.3 设置方法

https://blog.csdn.net/chengqiuming/article/details/81429641

参考 《什么是Live Template》 章节

2 方法注释

1.1 示例

/**
* 功能描述：生成签名
*
* @param publicEntity：用于生成签名的数据
* @return 生成签名字符串密文
* @author chengqiuming
* @date 2022/11/24
*/
public static String getSignature(PublicEntity publicEntity) throws Exception {
}

1.2 模板

/**
* 功能描述：
*
* @author chengqiuming
* @date $date$
* @param $params$
* @return $returns$
*/

1.3 设置方法

https://blog.csdn.net/chengqiuming/article/details/81429641

参考 《什么是Live Template》 章节

3 其它注释

1.1 加注释原则

如果不加注释，就看不懂，加了注释，就立马明白代码含义。

如果不加注释，阅读起来比较困难，比较慢，加了注释，阅读代码速度立即提高。

如果不加注释，就可能产生二义性，容易理解错误，加了注释，含义明确，理解正确。

1.2 示例

public class CNMoneyUtils {
    private static Logger logger = LogManager.getLogger(AliPayUtils.class);
    /**
     * 汉语中数字大写
     */
    private static final String[] CN_UPPER_NUMBER = {"零", "壹", "贰", "叁", "肆", "伍", "陆", "柒", "捌", "玖"};
    /**
     * 汉语中货币单位大写，这样的设计类似于占位符
     */
    private static final String[] CN_UPPER_MONETRAY_UNIT = {"分", "角", "元", "拾", "佰", "仟", "万", "拾", "佰", "仟", "亿", "拾", "佰", "仟", "兆", "拾", "佰", "仟"};
    /**
     * 特殊字符：整
     */
    private static final String CN_FULL = "整";
    /**
     * 特殊字符：负
     */
    private static final String CN_NEGATIVE = "负";
    /**
     * 金额的精度，默认值为2
     */
    private static final int MONEY_PRECISION = 2;
    /**
     * 特殊字符：零元整
     */
    private static final String CN_ZEOR_FULL = "零元" + CN_FULL;
}

4 关于无用注释

无用注释一定要果断删除，不要保留，有以下原因。

a 影响代码整体美观。

b 看别人代码时，多一行代码，多阅读一行，减低阅读代码效率。

c 如果意外启用，代码会出现错误，而且排查起来会十分困难。

二 格式化

目前主流代码编辑工具都有格式化功能，提交代码前一定要格式化一下，这一简单操作，代码颜值立马提高数倍。