代码审计至少包含两个方面首先要确定代码的目的或功能;另外就是检查代码的可读性,即是否更利于理解和维护。
或许你审计过很多代码,太长的变量名确实很让人抓狂。不仅影响了代码的清晰度,而且过长的变量让你的代码难以扫描,迫使更多的换行。
如何给变量或方法取个好名字
首先你要知道这个命名想要表达什么;另外你应该知道这个命名跟什么是无关的。 除此之外,所有的命名中所有的字符串都是多余的。
(1)省略变量的参数类型
如果是静态类型的语言,你是会知道变量的类型或方法返回值类型,再在命名上加上类型就是多余了
// Bad:
String nameString;
DockableModelessWindow dockableModelessWindow;
// Better:
String name;
DockableModelessWindow window;
// Bad:
List<DateTime> holidayDateList;
Map<Employee, Role> employeeRoleHashMap;
// Better:
List<DateTime> holidays;
Map<Employee, Role> employeeRoles;
// Bad:
mergeTableCells(List<TableCell> cells)
sortEventsUsingComparator(List<Event> events,
Comparator<Event> comparator)
// Better:
merge(List<TableCell> cells)
sort(List<Event> events, Comparator<Event> comparator)
// Bad:
finalBattleMostDangerousBossMonster;
weaklingFirstEncounterMonster;
// Better:
boss;
firstMonster;
// Bad:
class AnnualHolidaySale {
int _annualSaleRebate;
void promoteHolidaySale() { ... }
}
// Better:
class AnnualHolidaySale {
int _rebate;
void promote() { ... }
}
class DeliciousBelgianWaffleObject {
void garnishDeliciousBelgianWaffle(
List<Strawberry> strawberries) { ... }
}
class Waffle {
void garnish(List<Strawberry> strawberries) { ... }
}