自定义关键词须遵循 Qt C/C++ Python 编程语言规范，且尽量不与其 Reserved Keyword 冲突或混淆。

 

1. Basic Requirement

---

关键词只可为大小写英文字母 数字 _ 的组合， 不能包含空格， 且不能以数字开头。

不推荐使用单个英文字母表示关键词，单个字符的突显可通过 Digital IDE 查找栏高亮键展示。

---

关键词必须简短 扼要，不推荐使用缩写字符 (特殊情况除外，譬如 FTS_Class 表示 Full Text Search Class)。

最好能直接表达出对象类型，便于后期维护及交流； For example: BaseFind_Class     findFile_fun     line_count     text_list     source_textlist

 

2. Class

---

首字母必须大写，Q 为 Qt 保留首字符，D 为乐数软件保留首字符。

最好采用能直接表达出对象类型的 _Class 结尾。

For example: BaseFind_Class

 

2.1 Method

首字母必须小写。

最好采用能直接表达出对象类型的 _Method 结尾。 For example: lineCount_Method

当然，可借鉴 Qt 信号槽机制以 _Slot 结尾 (譬如：runFile_Slot)； 在此情况下，最好是没有或有少数变量 (自变量由 Qt 信号传入)。

 

2.2 Variable

首字母必须小写。

最好采用能直接表达出对象类型的字符结尾， 不要在中间添加 _ 字符 (以区别局部 全局变量)。

For example: self.lineCount     self.textList     self.sourceTextList

 

Note:

不推荐在开头｜结尾添加 _ 字符。

这样容易与 Qt C/C++ Python 现有关键词相混淆， 不便于后期维护。

 

2.3 Feature

定义似 Class Method ，但必须在上部添加装饰器 @property。

类特性用法似 Class Variable ，但可在特性定义中添加额外附加条件 (或预处理传入自变量)。

 

为区别于类方法，推荐去除 _Method。

For example: stateCode     stateLine     headerDict

---

首字母必须小写。

最好采用能直接表达出对象类型的 _fun 结尾。

For example: findFile_fun

 

4. Variable

---

字符须全小写，除非必要，才大写。

最好采用能直接表达出对象类型的字符结尾， 虽然 Python 是动态编程语言。

For example: line_count     text_list     source_textlist

 

4.1 Local

必须全小写，中间可添加 _ 字符。

For example: amount     count     dump     file_name     string     text

 

与保留关键词同名的变量， 可采用复数 (或过去式)。

For example: called     lists     tuples

 

4.2 Global

工程级全局变量推荐全大写， 中间可添加 _ 字符。

For example: NO_RUN

 

模块级全局变量推荐全小写， 中间可添加 _ 字符。

For example: app_name

 

4.3 Special

采用 __ 结尾或开头， 若无必要，请尽量少用。

借鉴自 Python 特殊类方法及特殊全局变量语法规则。

For example: __named__