Skip to content

命名风格

】请选择使用英文字符命名应用、页面、服务端命令、GET 请求入参,避免使用中文。

📍 INFO

对于 URL,非英文字符会按照操作系统的字符集进行编码后提交到服务器,服务器会按照配置的字符集进行解码,如果编码时的字符集与解码使用的字符集不一致,会出现乱码现象。

在活字格中,应用名称、页面名称、服务端命令名称,GET 请求入参名称都有机会出现在 URL 中,英文字符命名可以跳过编码与解码的流程,避免出现异常。

】不同的模块命名建议采用不同的命名法,便于通过名称识别内容。

📍 INFO

变量名称、单元格名称经常会在同一处页面逻辑中呈现,如果采用相同的命名法,很难区分当前名称描述的是变量还是单元格。如下是几种可供参考的命名法:

  • 变量:推荐采用 小驼峰命名法(lowerCamelCase);
  • 单元格:推荐采用 匈牙利命名法(Hungarian);
  • 服务端通知:推荐采用 大驼峰命名法(UpperCamelCase)/ 帕斯卡命名法(Pascal)。

】命名中建议体现元素特有的行为或属性。

📍 INFO

  • 如果命名「服务端命令」,建议使用动词词组体现行为;
  • 如果命名单元格,建议使用名词词组体现属性。
🔎 示例
  • 服务端命令:GetUserInfo / UpdateUserInfo / DeleteUser / AddUser
  • 单元格: userIdCell / userInfoTable
  • 变量:userInfoArray / productIds

】参数大小写统一,活字格中没有严格的参数校验,所以很容易造成参数名称或者大小写不匹配的情况发生。