python - 我应该如何命名我的类和函数甚至字符串？

Question

如您所说，我是 Python 新手。我已经阅读了各种文档，但我仍然无法弄清楚是否有针对字符串函数，当然还有类的“命名最佳实践”。

如果我想将类或函数命名为站点地图，可以使用站点地图吗？例如，它应该是 Site_map 还是任何其他东西？

谢谢!

附言。非常感谢任何进一步的阅读资源!附言。我正在做网络应用程序开发(学习，更确切地说!)

Answer 1

命名约定:

我使用了多种 Python 命名约定。这里的一致性当然很好，因为它有助于识别对象名称指向的对象类型。我认为我使用的约定基本上遵循 PEP8 .

1) 模块名称应为小写字母，并带有下划线而不是空格。 (并且应该是用于导入的有效模块名称。)

2) 变量名和函数/方法名也要小写 用下划线分隔单词。

3) 类名应该是 CamelCase(大写字母开头， 单词连在一起，每个单词都以大写字母开头)。

4)模块常量应该全部大写。

例如您通常会有 module.ClassName.method_name。

5) CamelCase 中的模块名称与主类名称相同 模块名称很烦人。 (例如 ConfigParser.ConfigParser，它 应始终拼写为 configobj.ConfigObj。)

6) 此外，不属于您的公共(public) API 的变量、函数、方法和类应以单个下划线开头。 (使用双下划线将属性设为私有(private)几乎总是被证明是错误的——尤其是在可测试性方面。)

空格

最后，您应该始终在运算符周围和标点符号后留有空格。方法和函数的默认参数除外。

例如def 函数(默认=参数):和 x = a * b + c