JS书写规范

JS 变量命名

命名方法

小驼峰式命名

命名规范

前缀应当是名词。(函数的名字前缀为动词,以此区分变量和函数)

命名建议

尽量在变量名字中体现所属类型,如:length、count等表示数字类型;而包含name、title表示为字符串类型。

示例
// 好的命名方式
var totalCount = 10;
var tableTitle = 'Table';
// 不好的命名方式
var setCount = 18;
var getTitle = 'Table';

JS 函数命名

命名方法

小驼峰式命名法

命名规范

前缀应当为动词

命名建议

可使用常见动词约定

动词 含义 返回值
can 判断是否可执行某个动作(权限) 函数返回一个布尔值。true:可执行;false:不可执行
has 判断是否含有某个值 函数返回一个布尔值。true:含有此值;false:不含有此值
is 判断是否为某个值 函数返回一个布尔值。true:为某个值;false:不为某个值
get 获取某个值 函数返回一个非布尔值
set 设置某个值 无返回值、返回是否设置成功或者返回链式对象
load 加载某些数据 无返回值或者返回是否加载完成的结果
示例
function hasChild () {}
function isChild () {}

JS 常量命名命名方法

命名规范

名称全部大写,使用大写字母和下划线来组合命名,下划线用以分割单词

示例
var MAX_COUNT = 10;
var URL = 'http://www.runoob.com'; 

JS 文件命名

命名规范

使用短线(-)或句点(.)作为分隔符号,推荐使用句点,最好使用小写英文字符,不要使用其他符号和扩展字符。

示例
vue.config.js

js 注释格式

命名规范

单行使用//, 多行使用/* 注释 */

示例
// 单行注释

/*
* 多行注释
* 多行注释
* 多行注释
*/

参考网址:
https://blog.csdn.net/weixin_30772261/article/details/95676042

你可能感兴趣的:(JS书写规范)