🔥码云GVP开源项目 12k star Uniapp+ElementUI 功能强大 支持多语言、二开方便! 广告
1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束; 反例:\_name , \_*namename*, name$ , Object$,name__ 2. 【**强制**】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式; 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用 正例:renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。 反例:getXiaoxi()\[获取消息\] , getPingfen() \[获取评分\] 3. 【**强制**】类名使用 HookAddonsCase 风格,必须遵从大驼峰形式; 正例:Goods,OrderGoods,HookAddons 反例:macroPolo,XMLService 4. 【**强制**】方法名统一使用 getUserName 风格,必须遵从小驼峰形式; 正例: getUserName,getUserAddress 5. 【**强制**】函数名统一使用 get\_user\_name 风格,必须使用小写字母, 不能使用数字,每个单词用下划线分割; 正例:get\_user\_name ,get\_user\_address 反例:get\_user\_name1,GET\_user\_Name 6. 【**强制**】命名空间统一使用 app\\admin\\model 风格,必须使用小写字母, 不能使用数字,下划线,大写字母; 正例:app\\admin\\model,app\\admin\\controller 反例:app\\admin\\Controller 7. 【**强制**】杜绝完全不规范的缩写,避免望文不知义; 反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性 8. 【推荐】为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词组合来表达其意; 正例:获取用户名称的名称为 get\_user\_name 或get\_username。 反例:变量 $a = 1; 的随意命名方式。 9. 【强制】文件命名 1)模块名只允许小写字母, 2)控制器,模型,验证器文件名同类名一致 3)模板文件一律使用小写,驼峰法命名的控制器方法对应的模板请直接使用下划线分隔开,严禁出现大小写混用的模板文件名,避免在Linux服务器下因为大小写而报模板找不到的错误 正例:goods\_add.html 反例:goodsAdd.html 10. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长; 正例:UID,ROOT\_DIR 11. 【**强制**】各控制器,模型方法命名规约: 1) 获取单个对象的方法用 get 做前缀; 2) 获取多个对象的方法用 list 做前缀; 3) 获取统计值的方法用 count 做前缀; 4) 插入的方法用 save/insert 做前缀; 5) 删除的方法用 remove/delete 做前缀; 6) 修改的方法用 update 做前缀;