Python UML 图

Python UML Diagrams

我正在为 Python class 创建 UML 图。

在为 Python 程序做 UML 时包含 public/private/protected 标签是标准的吗?例如:

-n: int
+name_of_shop: str

我当前的程序的每个变量和函数都与 public 相同,因为我不希望我的变量以单 (_) 或双 (__) 下划线开头。如果不在函数外访问变量,是否每个变量都以双下划线开头是标准的?

没有Python 标准 相对于 UML。两种范例都有约定。如何解决它们取决于您和您的消费者,即评估您的工作的人。

Python 本身在语言语法的必要性之外强加了很少的标准。请记住我们的首要原则:"A Foolish Consistency is the Hobgoblin of Little Minds"。您可以查看 coding guidelines(通常称为 PEP-8 编码标准)。

也就是说,我有两个基本的注意事项:

  1. 是的,内部变量通常以下划线开头。
  2. 您需要与您的讲师 and/or 评分员讨论可读性和得体性。

如果你的问题是是否使用下划线,PEP8 有 Descriptive: Naming Styles
基本上说

  • _弱 "internal use" 指标的单下划线前缀
  • 单_下划线后缀,避免与关键字冲突
  • __double mangles 的下划线前缀
  • __ double__ 两端的下划线表示不应发明的魔法。