[Pyqt-Node-Editor]Nodeeditor文档--Coding Standards（编码标准）

Coding Standards

在整个 nodeeditor 包中使用以下规则和指南：

File naming guidelines（文件命名指南）

• nodeeditor 包中的文件以 node_ 开头
• 包含图形表示（PyQt5 覆盖类）的文件以 node_graphics_ 开头
• 窗口/小部件的文件以 node_editor_ 开头

Coding guidelines（编码指南）

• 方法使用驼峰命名法
• 变量/属性使用 Snake 大小写命名
• 构造函数__init__始终包含整个类的所有类变量。这对新用户很有帮助，因此他们只需查看构造函数并在一个地方阅读该类正在使用的所有属性。没有人希望以后代码中隐藏任何惊喜
• nodeeditor 使用自定义回调和侦听器。添加回调函数的方法通常命名为 addXYListener
• 自定义事件通常被命名 onXY
• 命名的方法doXY通常执行某些任务，并负责低级操作
• 类总是按以下顺序包含方法：
  -：
  init
  python魔术方法（即__str__），setter和getter
  initXY 功能
  侦听器功能
  节点编辑器事件函数
  节点编辑器doXY和getXY帮助功能
  Qt5 事件函数
  其他功能
  可选覆盖 Qtpaint方法
  serialize和deserialize方法在最后