- 英文单词保证拼写正确。
- 尽量不使用中文拼音;
- 重要常量、变量、方法等保证详细注释,关键业务逻辑进行详细记录;
- 变量命名时使用有意义的英文单词,建议使用前缀或后缀标识变量类型,如str(字符串),num(数字),bol(boolean),obj(对象),arr(数组);
临时变量可以简写,比如:str,num,bol,obj,fun,arr等。 - 勿使用1、2、3,a、b、c等无意义命名,循环变量可以简写,比如:i,j,k等;
- 相同含义的变量命名风格保持统一,如arrayList/array-list;
- 命名尽量区分单复数,清楚表达含义,可以使用list或加s标识复数,根据数据类型命名;
- 私有变量,推荐使用”_”开头,小驼峰命名,如var _this = this;
- Html、css文件命名小驼峰命名,如login.html;
- Js文件命名大驼峰式命名,如DataFactory.js;
- 常量,大写字母,下划线“_”分隔;
- Css 样式命名,按页面元素分级命名,可使用“-”分隔,尽量表达清楚含义;
- 方法命名时常用动词:can/has/is(状态)、get(获取值),set(设置值),handle(处理操作)、add(添加)、delete/remove(删除/移除)、edit、query/search、load、reload、refresh、create/destroy、start/stop, insert、begin/end等。
常用介词:before、after、in、on、over等 - 方法可以使用@param @return进行参数和返回值的注释;
- 文件夹和文件使用小写字母,增加可移植性和易读性;
- 尽量不在window下定义全局变量;
- 注意对象或数组最后元素后不能多逗号,chrome下没问题,IE下会报错;
- 多行块代码尽量使用{};
- 使用FIXME 或 TODO 记录待完成问题。
前端编码规范
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。
推荐阅读更多精彩内容
- 序言 首先看下我们要实现的效果是怎么样的。通过下面的图片,可以看到,左边就是书籍目录的导航栏,导航栏的上面还有全局...