编写卓越代码之命名那些事儿 -- 2

最新推荐文章于 2023-05-09 14:05:32 发布

原创最新推荐文章于 2023-05-09 14:05:32 发布 · 156 阅读

CC 4.0 BY-SA版权

1 篇文章

订阅专栏

本文探讨了在编程中如何通过为变量名附加单位或属性来提高代码的可读性和易理解性，例如使用period_ms而非period来明确单位。

为名字附加相关信息

函数参数、变量、配置文件中的属性Key中我们经常会涉及到带有度量信息的名字，如常见的定时任务执行的period，如：

bpm.job.period = 300000

一般我们知道period的单位为毫秒(ms)，但是有时候我们会很难清晰的指导该变量值的单位是什么，毫秒、秒、分钟还是小时，幸运一点可以通过注释得到答案，不幸的时候你需要自己测试一下或者读相应的代码才可以知道，如下面这个函数：

Date addWorkTime(Date startDate, int addTime) throws Exception;

那么这里addTime的单位是什么呢，很难通过参数名称知道，如果我们替换成下面这个声明：

Date addWorkTime(Date startDate, int addMintues) throws Exception;

那么很清晰我们知道单位是分钟，而不是秒或者小时。同样在我们测试一个函数执行时间的时候我们可以使用下面这样的变量声明：

long start_ms = new Date().getTime();

// 代码执行

long elapsed_ms = new Date().getTime - start_ms;
System.out.pringln("执行耗时：" + elapsed_ms + "ms");

同样还有像下面这些函数：

void start(int delay_secs);

void roate(float degrees_cw);

void createCache(int size_mb);

另外，我们经常会对字符串进行编码解码、加密解密等处理，在命名的时候其实都可以为它们附加相应的属性，如：

plaintext_password             -- 未加密的口令
unescaped_comment           -- 未转义的注释/意见
html_utf8                              -- 已转化为UTF-8编码的html

等等。