dram.me

Modula-2中的命名规范

在编程实践中,规范化的命名对于代码的可读性、可维护性来说非常重要,例如这份针对JavaScript编码规范的梳理

最近在学习Modula-2,想就此整理一份个人建议的Modula-2命名规范。

总原则是:导出的外部元素(包括模块外部变量、过程、类型以及顶层模块)以首字母大写的标题式(TitleCase)命名,内部元素以首字母小写的驼峰式(camelCase)或者全小写(lowercase)命名,由于Modula-2默认不支持在标识符中使用下划线(_),所以蛇型(snake_case)的命名风格不在这里使用。

在此原则的基础之上,以动词类和名词类词语划分:变量、常量、类型、模块使用名词类词语,过程使用动词类词语。

由于全小写模式可读性不如驼峰式,特别是对于多词语组合的标识符,例如过程名,所以内部过程使用驼峰式命名。

由于类型和变量常有重名的情况出现,所以在命名规范上将内部变量与内部类型区分开,内部类型使用驼峰式命名。

其他为全小写的模式,包括内部常量、变量,以及内部模块名。