代码审计至少包含两个方面首先要确定代码的目的或功能；另外就是检查代码的可读性，即是否更利于理解和维护。

或许你审计过很多代码，太长的变量名确实很让人抓狂。不仅影响了代码的清晰度，而且过长的变量让你的代码难以扫描，迫使更多的换行。

如何给变量或方法取个好名字

首先你要知道这个命名想要表达什么；另外你应该知道这个命名跟什么是无关的。 除此之外，所有的命名中所有的字符串都是多余的。

(1)省略变量的参数类型

如果是静态类型的语言，你是会知道变量的类型或方法返回值类型，再在命名上加上类型就是多余了

1. // Bad: 
2. String nameString; 
3. DockableModelessWindow dockableModelessWindow; 
4.   
5. // Better: 
6. String name; 
7. DockableModelessWindow window; 

可用复数代替某些类型

1. // Bad: 
2. List<DateTime> holidayDateList; 
3. Map<Employee, Role> employeeRoleHashMap; 
4.   
5. // Better: 
6. List<DateTime> holidays; 
7. Map<Employee, Role> employeeRoles; 

方法名不应该描述参数或其类型

1. // Bad: 
2. mergeTableCells(List<TableCell> cells) 
3. sortEventsUsingComparator(List<Event> events, 
4.     Comparator<Event> comparator) 
5.   
6. // Better: 
7. merge(List<TableCell> cells) 
8. sort(List<Event> events, Comparator<Event> comparator) 

(2)省略命名中的歧义描述

当你看到这个变量名recentlyUpdatedAnnualSalesBid你是不是在想

有没有年度销售报价不是最近的?

最近的年销售报加有没有没更新的？

有没有最近更新的销售报价不是年度的？

...

请去掉这些无关的描述吧，何况你可以加注释嘛。

1. // Bad: 
2. finalBattleMostDangerousBossMonster; 
3. weaklingFirstEncounterMonster; 
4.   
5. // Better: 
6. boss; 
7. firstMonster; 

(3)去掉上下文已知的内容

比如说当class描述了某个内容，方法名就不需要再重复了

1. // Bad: 
2. class AnnualHolidaySale { 
3.   int _annualSaleRebate; 
4.   void promoteHolidaySale() { ... } 
5. } 
6.   
7. // Better: 
8. class AnnualHolidaySale { 
9.   int _rebate; 
10.   void promote() { ... } 
11. } 

(4)省略掉无意义的信息

很多人喜欢命名基于产品的很多商业名词，比如data, state, amount, value, manager,engine, object, entity, and instance.这些词是否存在没有意义。

看下面一个联系

1. class DeliciousBelgianWaffleObject { 
2.     void garnishDeliciousBelgianWaffle( 
3.         List<Strawberry> strawberries) { ... } 
4. } 

简化成这样是不是很爽

1. class Waffle { 
2.   void garnish(List<Strawberry> strawberries) { ... } 
3. }

Tags: 歧义 变量 名字

分享到：