如何正确注释类实例

Posted 2023-03-22

【中文标题】如何正确注释类实例

【英文标题】：How to properly annotate a class instance

【发布时间】：2021-10-16 05:52:47

【问题描述】：

我正在阅读PEP 526 文档，我想知道注释类实例的正确方法是什么。

我在文档中没有找到答案。

我有以下模块：

class global_variables:
     # Class body

global_variables_dictionary: global_variables = global_variables("application.yaml")

something: <class_name> = class_name() 是正确的做法吗？

谢谢

【问题讨论】：

注释任何内容的方式相同，所有内容都是 Python 中的类实例

【参考方案1】：

是的。顺便提一句。您应该避免使用小写字母命名类。对于 PEP，您应该使用驼峰式大小写：

每个单词都以大写字母开头。不要将单词与 下划线。这种样式称为驼峰式。

【参考方案2】：

是的，这是正确的方式，但在我看来，类名不应该是小写的。

【讨论】：

这不仅仅是你的意见，即PEP 8 -- Naming Conventions。