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

 

1. 基本要求


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

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

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

最好能直接表达出对象类型,便于后期维护及交流; 譬如: BaseFind_Class     findFile_fun     line_count     text_list     source_textlist

 

2. 类


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

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

譬如: BaseFind_Class

 

2.1 方法

首字母必须小写。

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

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

尽可能不要缩写,如 lnCount_Method 辨识度就差一些。

 

2.2 变量

首字母必须小写。

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

譬如:self.countLine   self.countLineText   self.listText   self.listTextSource

可缩写但不要过度,如 self.countLn 还好但 self.couLn 辨识度就很差。

 

注意:

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

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

 

2.3 特性

定义似 类方法 ,但必须在上部添加装饰器 @property。

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

 

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

譬如: stateCode     stateLine     headerDict

 

3. 函数


首字母必须小写。

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

譬如: findFile_fun

 

4. 变量


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

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

譬如: line_count     text_list     source_textlist

 

4.1 局部

必须全小写,连续单词的首字符可大写,中间可添加 _ 字符。

譬如:amount   count   dump   file_name   no_runlist   no_runList

 

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

譬如: called     lists     tuples

 

4.2 全局

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

譬如:NO_RUN   NO_RUNLIST

模块级全局变量同局部变量,中间可添加 _ 字符。

譬如:no_run   no_runlist   no_runList

 

4.3 特殊

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

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

譬如: __named__