|

《易语言中文编程社区通用代码及编译配置项规范 v0.2》(以下简称“《易码规范》”)
规范说明:
易语言社区源码混乱。模块要实现的简便快捷,却每次编译时都因编译器的配置不一,还要重新配置;代码风格不一,虽然易语言自带格式化代码,但对标识符的命名风格又是百花齐放,故起草《易码规范》,同时也希望大家在写代码时尽量遵守《易码规范》,特别是写供他人使用的模块时请注意遵守。
规范内容:
- 系统配置-编译配置项中,启用“调用DLL命令后是否检查堆栈错误”,“严格的重复名称检查”,“严格的参数参考传递检查”,“数值精度丢失检查”;不指明“是否启用快速数组访问方式”,“非独立编译后是否询问写出相关库”。重复的命名中在下条命名规范说明;精度丢失可以使用“到【类型】”命令,但某些类型间的转换可能会出现问题,返回空值,所以你可以使用“到文本”命令作“中介”保证大部分类型转换的安全。
- 命名规范的问题一直影响的易语言用户,所有标识符,都应“尽可能的使用中文命名”,这不仅仅方便阅读,也是民族文化自信的体现。在《易码规范》中不建议添加无意义字符消除重复命名,因为这样的命名是无意义的;一些对象性质上一样,但数据类型不同(如窗口实例与该窗口的句柄),须要能在命名中体现,一般在后加下划线“_”再加信息(如“主窗口_句柄”);另外,需要备注强调其主要功能的命名不算严谨。
· 变量名: 根据变量所处位置不同使用“全局_”(模块中全局变量无需使用此前缀)、“程序集_”或“局部_”开头加名词命名。在“一般”情况下,逻辑型变量常以“是否”开头;用于一些循环语句且无特别意义用来记录次数的命命名为“计次”,若需要多个,尽量声明为数组。
· 子程序名:子程序是种行为,所以使用动词短语命名,附加信息(如方式,用于区分不同方式的同一种行为)使用下划线“_”与前面隔开(这样符合读写顺序,若有多个附加信息,需要排列),例如“加载数据_通过字节集”。
· 参数名:与变量名相同,但以“参_”开头命名。
· 类名:使用“类_”开头加名词命名。
- 模块中的命名:在《易码规范》中将引入“模块命名空间”,即“ID”(是唯一的,又称“唯一名”),命名空间要求简短。对外开放的全局变量、类模块等(不包括类方法),以“【模块命名空间】_【其他】”命名;至于子程序,《易码规范》建议使用若干类模块存放的方法,其中与对外开放的方法勾中“公开”,故称这些类为接口类(一般不公开),主接口类使用“【模块命名空间】”命名,分类用的副接口类使用“【模块命名空间】_【方法类别】”命名,然后将这些接口类实例化,即在全局变量中声明以这些类模块为类型的全局变量,变量名同这些类模块的类名,这些全局变量供用户调用,以保证不重复命名。
如果在自己的易语言源码中遵循了《易码规范》,可以在源码消息中申明“易码规范 *.*”。
IDE颜色配置建议使用显明配色,对变量作用域的不同进行高亮。若此规范有不妥的地方还请大家指教改正,感谢阅读!
感谢 @LLJ 提出的建议。
|
|