■ 前端部分
HTML标签的class属性值和id属性值均使用中横线风格,示例:
<div id="form-group">
<span class="border-bottom">...</span>
</div>
URL的文件名使用中横线风格,参数名使用下划线风格,示例:
https://www.domain.com/filename-demo.html?out_trade_no=1217752501201407033233368018&goods_tag=WXG
表单中<input>的name属性值使用下划线风格,示例:
<input name="out_trade_no" type="text" value="1217752501201407033233368018">
<input name="goods_tag" type="text" value="WXG">
按钮必填属性[type="button"][action="xxxxx"]并默认禁用,等绑定好点击事件再解除禁用态,示例:
<button type="button" action="login" disabled>登录</button>
<button type="button" action="search" disabled>搜索</button>
<button type="button" action="article-add" disabled>发布</button>
<button type="button" action="submit" disabled>提交</button>
说明①:先使用$('[action="xxxxx"]').click()绑定点击事件,再使用$('[action="xxxxx"]').prop('disabled', false)解除禁用态。
说明②:如果点击事件是执行AJAX请求,那么应该在beforeSend回调里禁用按钮防止重复点击,然后在complete回调里解除禁用态。
■ 后端部分
变量名使用小驼峰风格,对于一类特定类型数据建议使用固定的变量名来保存,以达到望文知义的效果,示例:
$ok:true=成功或正常|false=失败或异常
$row:数据库查询结果集(单条)
$rows:数据库查询结果集(多条)
$count:数据库查询记录数
$counter:计数器(递增或递减均可)
$isXxx:true=是|false=否,如:$isDelete
自定义常量名(不管是普通常量还是类常量)使用全大写下划线风格,如以下内置常量:
PHP_VERSION、E_WARNING、UPLOAD_ERR_INI_SIZE
自定义函数名使用全小写下划线风格,如以下内置函数:
var_dump()、array_key_exists()、str_replace()、preg_match_all()
自定义类名使用大驼峰风格,类方法名使用小驼峰风格(不推荐使用下划线前缀来表明protected/private可见性),如以下内置类:
ReflectionFunctionAbstract::getNumberOfRequiredParameters()
ReflectionEnumBackedCase::getBackingValue()
SimpleXMLElement::registerXPathNamespace()
类名正例:XmlService、TcpUdpDeal
类名反例:XMLService、TCPUDPDeal
自定义类属性名使用小驼峰风格(不推荐使用下划线前缀来表明protected/private可见性),如以下内置类的属性名:
DOMDocument::xmlEncoding
DOMDocument::strictErrorChecking
■ 数据库部分
唯一索引名:unique:字段名1,字段名2,字段名3
普通索引名:index:字段名1,字段名2,字段名3