代码整洁之道

Posted 2022-11-24 优雅的心情

文章目录

• 一、有意义的命名
• • 1.名副其实
  • 2 .避免误导
  • 3 .做有意义的区分

一、有意义的命名

软件中随处可见命名。我们给变量、函数、参数、类和封包命名、源代码文件命名、目录命名，良好的命名规范使得代码以及工程的维护难度大大降低，下面列出良好命名的几条简单规则。

1.名副其实

变量、函数或类的名称应该已经答复了所有的大问题。它应该告诉你，它为什么会存在，它做什么事，应该怎么用。如果名称需要注释来补充，那就不算是名副其实。

int d # 消逝的时间，以日计

名称d什么也没有说明。它没有引起对时间消逝的感觉，更别说以日计了。我们应该选择指明了计量对象和计量单位的名称：

int elapseTimeInDays

2 .避免误导

• 别用accountList来指称一组账号，除非它真的是List类型。如果包含账号的容器并非是个List，就会引起错误的判断。所以用accountGroup或者bunchOfAccounts，甚至直接用accounts都会好一些。
• 提防使用不同之处较小的名称。想区分模块中的某处的XYZControlForEfficientHandlingOfStrings和另一处的XYZControlForEfficientStorageOfStrings，会花多长时间呢？这两个词外形实在太相似了。
• 误导性名称可怕的例子，是用小写字母l和大写字母作为变量名，尤其是在组合使用时。当然，问题在于他们看起来完全像是常量“一”和“零”。

O=9
l=8
if O==l：
   print("结果相等")
else:
   print("结果不相等")    

3 .做有意义的区分