竹笋

首页 » 问答 » 常识 » 必知必会系列python代码优雅之道之
TUhjnbcbe - 2024/7/8 2:19:00

代码的命名约定对代码的提高可读性影响巨大。本文中,我们将总结并向您提供一些关于命名的最佳实践的示例,以帮助您编写更优雅的Python代码,使将来可能阅读和使用您的代码的人(包括您自己)受益。

Python是一种面向对象的编程语言。这意味着您将在任何给定的Python项目中创建、命名和使用各种对象。我们的命名约定是命名所创建对象的经验法则。理解这些约定是保持代码可读性的重要一步。

基本命名约定

让我们从最常见的Python对象命名开始。以下是命名的基本方法:

单小写字符

通常用于函数中的局部变量,如x或i;

单大写字符

通常用于命名矩阵;

小写单词

最常见的对象命名约定;

带下划线的小写单词

与小写单词的用法相同,但用于更复杂的名称;

大写单词

用于单个单词的静态变量;

带下划线的大写单词

用于多个单词的静态变量;

单词首字母大写(又名大小写)

这种约定是每个单词首字母大写,它们之间没有空格或下划线。用于命名类;

混合类型

从一个小写单词开始,然后是其他每个单词首字母大写。这种约定主要在Java中使用,而在Python中使用较少

以上每种约定都有不同的使用情况。这些约定不仅仅是为了美观,而且还可以帮助您在代码中创建有意义的对象。

要避免使用的名称

以下是编写Python代码时要避免的约定。

一是我们要避免使用在某些字体中,和数字“1”和“0”无法区分的名称,这使得用户很难理解。二是还应该避免使用Python关键字和内置的类/函数名作为变量名。例如,“max”、“sum”、“class”和“list”等词是任何Python环境中已经存在的。将它们用于其他用途可能会使代码运行变得混乱。

模块和包

模块是用于执行某些任务的预构建函数和其他对象的集合。模块应该有简短的小写名称。如果模块名提高了可读性(比如使用了多个单词的名称),那么可以在模块名中使用下划线。

包类似于包含模块和其他对象的目录。Python包应该遵循相同的约定,尽管不鼓励在包名中使用下划线。

变量和函数

在Python中,变量和函数的名称应该是小写的。需要时可以用下划线分隔单词。这将提高代码的可读性。类的方法命名应遵循与函数名相同的约定。

以下是命名变量和函数时要遵循的一些最佳实践:

常量应该用大写字母表示,必要时可用下划线隔开;

使用代表对象含义的名称,而不是无意义的单词名称;

应保留名称i、j和k以表示索引值;

理解并采用这些最佳实践是提高您的编码技能的一个很好的方法。

1
查看完整版本: 必知必会系列python代码优雅之道之