APP
2025
v2.6.3.9 build 20251111.234548
自定义关键词须遵循 Qt C/C++ Python 编程语言规范,且尽量不与其 保留关键词 发生冲突 (或混淆)。
关键词 只可以是大小写英文字母、数字、_ 的组合,不可以包含空格,且不能以数字开头。
不推荐使用单个英文字母表示关键词,单个字符的突显可通过 数字 IDE 查找栏高亮键展示。
关键词必须简明、扼要、易于理解,不推荐使用字符缩写。
特殊情况除外,譬如 FTS_Class 表示 Full Text Search Class。
最好能直接表达出对象类型,便于后期维护及交流,譬如:
BaseFind_Class findFile_fun line_count text_list source_textList
首字母尽量大写,Q 为 Qt 保留首字符,D 为 Logiciel Numérique Heureux 保留首字符。
最好采用能直接表达出对象类型的 _Class 结尾。
Par Exemple:
BaseFind_Class BaseFindClass
首字母尽量小写。
最好采用能直接表达出对象类型的 _Method 结尾,譬如:
lineCount_method lineCount_Method
当然,可借鉴 Qt 的信号槽机制以 _Slot 结尾,譬如:runFile_Slot。
在此情况下,最好是没有 (或少数) 自变量, 自变量由 Qt 信号传入。
尽可能不要缩写,如 lnCount_Method 辨识度就差一些。
首字母尽量小写。
最好采用能直接表达出对象类型的字符开头,不要在中间添加 _ 字符 (以区别局部 全局变量)。
譬如:self.countLine self.countLineText self.listText self.listTextSource
可缩写但不要过度,譬如:self.countLn 还好,但 self.couLn 辨识度就很差。
注意:
不推荐在开头或结尾,添加 _ 字符。
这样容易与 Qt C/C++ Python 现有关键词相混淆,不便于后期维护。
定义像 类方法 ,但必须在上部添加装饰器 @property。
类特性用法似 类变量 ,但可在特性定义中添加额外附加条件 (或预处理传入自变量)。
为区别于类方法, 强烈推荐 去除 _Method。
Par Exemple: stateCode stateLine headerDict
首字母尽量小写。
最好采用能直接表达出对象类型的 _fun 结尾。
Par Exemple:
findFile_fun findFile_Fun
字符须全小写,除非必要,才大写。
最好采用能直接表达出对象类型的字符结尾,虽然 Python 是动态编程语言。
Par Exemple: line_count text_list source_textList
必须全小写,连续单词的首字符可大写,中间可添加 _ 字符。
Par Exemple: amount count dump file_name no_runList
与保留关键词同名的变量,可采用复数 (或过去式、进行时、动词变复数名词)。
Par Exemple: called getting lists tuples
注意:
不推荐 text_lists (易与 lists 混淆),强烈推荐使用 text_list。
因为单词组合已经可以表明此关键词的用途,且不会与现有 保留关键词 产生混淆。
工程级全局变量推荐全大写,中间可添加 _ 字符。
譬如:NO_RUN NO_RUNLIST
模块级全局变量同局部变量,中间可添加 _ 字符。
Par Exemple: no_run no_runList
注意:
不推荐 text_lists (易与 lists 混淆),强烈推荐使用 text_list。
因为单词组合已经可以表明此关键词的用途,且不会与现有 保留关键词 产生混淆。
采用 __ 结尾或开头,若无必要,请尽量少用。
借鉴自 Python 特殊类方法及特殊全局变量语法规则。
Par Exemple: __named__