Skip to content
idl 定义规范
- idl文件按功能模块划分,结构体和api定义分2个文件
- api的请求参数,返回结果解构遵循ApiReq, ApiResp命名规范
- 针对提供给h5的接口不需要生产gen-java,gen-cocoa的idl,放到 mapi/only-h5 目录
- 针对老版本接口新版本客户端不适用,对应的idl添加deprecated描述,详见home.thrift(homeV2Req,homeV2Resp), homeapi.thrift(homeV2)
编码规范
- PHP代码文件必须以 不带BOM的 UTF-8 编码, 所有PHP文件必须使用Unix LF (linefeed)作为行的结束符;
- 类的命名必须遵循 StudlyCaps 大写开头的驼峰命名规范;
- 类中的常量所有字母都必须大写,单词间用下划线分隔;
- 方法名称必须符合 camelCase 式的小写开头驼峰命名规范;
- 类的开始花括号({)必须写在函数声明后自成一行,结束花括号(})也必须写在函数主体后自成一行;
- 控制结构的开始花括号({)必须写在声明后自成一行,而结束花括号(})必须写在主体后自成一行;
- 方法的开始花括号({)必须写在函数声明后自成一行,结束花括号(})也必须写在函数主体后自成一行;
- 控制结构的关键字后必须要有一个空格符,而调用方法或函数时则一定不能有;
- 控制结构的开始左括号后和结束右括号前,都一定不能有空格符;
- PHP所有 关键字必须全部小写;
- 常量 true 、false 和 null 也必须全部小写;
参考资料
- PSR 规范