26
2019.2

命名规范

作者: POPASP
使用POPASP开发的过程中应该尽量遵循下列命名规范: * 类文件都是以.class.asp为后缀(这里是指的POPASP内部使用的类库文件,不代表外部加载的类库文件),文件名全部采用小写,例如popasp_controller.class.asp; * 确保文件的命名和调用大小写一致; * 控制器与模型的类名和文件名简化后保持一致,例如 UserAction类的文件命名是User.asp,在文件中定义时采用Class User, InfoModel类的文件名是Info.asp,在文件中定义时采用Class Info。命名得到了简化,程序会自动重写类名,实际上得到的依然是UserAction与InfoModel,但是网站开发者不必考虑其如何重写。并且不同的类库的类命名有一定的规范。2.0~2.2版本与后面的版本有很大的不同,举例中类文件名在2.2中分别是UserAction.class.asp与InfoModel.class.asp,如果想在高版本中使用这些命名规范,从3.1开始开始,可以进行相应的配置来兼顾老版本; * 函数、配置文件等其他类库文件之外的一般是以.asp为后缀(第三方引入的不做要求); * 函数的命名使用小写字母和下划线的方式,例如 get_client_ip; * 方法的命名最好使用驼峰法,首字母小写,例如 getUserName,parseType; * 属性的命名最好使用驼峰法,首字母小写,例如 tableName、instance; * 常量以大写字母和下划线命名,例如 HAS_ONE和 MANY_TO_MANY; * 配置参数以大写字母和下划线命名,例如HTML_CACHE_ON; * 语言变量以大写字母和下划线命名,例如MY_LANG; * 对变量的命名没有强制的规范,可以根据团队规范来进行; * 入口文件以.asp为后缀,include的模板文件以.html 为后缀; 特例:在POPASP里面,有一个函数命名的特例,就是大写单字母后加下划线函数,如 “B_” 函数,这类函数通常是某些操作的快捷定义,或者有特殊的作用。他们有着特殊的含义,后面会有所了解。

另外有一点非常关键,POPASP默认全部使用UTF-8编码,所以请确保你的程序文件采用UTF-8编码格式保存,并且去掉BOM信息头(去掉BOM头信息有很多方式,不同的编辑器都有设置方法,也可以用工具进行统一检测和处理),否则可能导致很多意想不到的问题。