【问题标题】:Are there any common Python naming conventions beginners should know?初学者应该知道哪些常见的 Python 命名约定?
【发布时间】:2021-05-16 08:40:19
【问题描述】:

Python 和一般编码的新手。我学到的越多(从不同的来源),我就越会继续听到“......这是一个常见的命名约定”这个短语。 出于第一次做对的愿望,我想知道 Python 中的大多数/许多常见命名约定是否有一个存储库或中心位置。 澄清一下,我的意思是使用“self”作为类的第一个参数,将 numpy 导入为 np,将 pyplot 导入为 plt,将 pandas 导入为 pd,等等......

我搜索了PEP 8 和 SO 和 Google(以及答案所建议的 Google 风格指南),但没有找到类似的东西。 拥有这样的资源值得吗?如果不是,为什么?

我既是一名刚接触编码的学生,也是一名经验丰富的(前)经理,他必须编写许多 SOP 并了解通用信息存储库的价值。

编辑:我将进一步澄清:“在创建类时将self 作为约定,还有哪些其他约定通常是初学者可能不知道的保留字?”

谢谢,

【问题讨论】:

标签: python pep8


【解决方案1】:

这是Google style guide. 非常有用。

正如您所说,您已经知道在整个公司内拥有良好的变量命名约定和实践的重要性。

虽然 Google 遵循这一规则,但那里的规则是体面且有用的,并且可以被许多人使用相同代码库的团队遵循。

【讨论】:

  • 非常有用且通才。这种“风格”实际上与许多其他语言兼容。例如。 K&R's.
  • 我已经更新了问题,但我也想感谢您的意见。我已经查看了整个 Google 风格指南,并且确实看到了它的实用性。但是,它并不能完全回答我的问题。考虑到这可能是我对问题的措辞,我将其改写为:“在创建课程时将'self'作为约定,还有哪些其他约定通常是初学者可能不知道的保留词?”
【解决方案2】:

许多不同的语言和编写代码的风格都有不同的命名约定。例如在 javascript 中有很多样式指南,代码是主观的,甚至像 AirBnb 这样的大公司也发布了他们自己的“样式指南”,许多公司都在复制。

如果您在文档中找不到它,一个好地方就是流行的 python 包、scipy、matplotlib、numpy 等...

这是文档中的命名约定部分: https://www.python.org/dev/peps/pep-0008/#naming-conventions

在 python 中,大多数人都同意“naming_like_this”,除了类等。

而在 JavaScript 中人们通常使用 camelCase "namingLikeThis"。

重要的是在每个代码库中保持一致,更重要的是有用地命名事物,而不是专注于编写事物的风格。

【讨论】:

    猜你喜欢
    • 2011-03-22
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2018-09-12
    • 2023-03-24
    相关资源
    最近更新 更多