在编码过程中,命名是重头戏。好的命名可以令代码赏心悦目,带来愉悦的阅读享受,令代码具有良好的可维护性。命令的主要范畴有变量、常量、方法、类、文件、包等。
1.变量命名
变量名都采用小驼峰式命名,即除了第一个单词的首字母不大写外,每个单词的首字母都大写,词与词之间没有任何符号,如:
var adminUser = {};
错误的示例如下:
var admin_user = {};
2.方法命名
方法命名与变量命名一样,采用小驼峰式命名。与变量不同的是,方法名尽量采用动词或判断型词汇,如:
var getUser = function () {};
var isAdmin = function () {};
User.prototype.getInfo = function() {};
错误示例如下:
var get_user = function () {};
var is_admin = function () {};
User.prototype.get_info = function () {};
3.类命名
类命名采用大驼峰式命名,即所有单词的首字母都大写,如:
function User {
}
4.常量命名
作为常量时,单词的所有字母都大写,并用下划线分割,如:
var PINK_COLOR = "pink";
5.文件命名
命名文件时,请尽量采用下划线分割单词,比如:child_process.js和string_decode.js。如果你不想将文件暴露给其他用户(私有),可以约定以下划线开头,如:_linklist.js。
6.包名
也许你有贡献模块并将其打包发布到NPM上。
在包名中,尽量不要包含js或node的字样,它是重复的。
包名应当适当短并且有意义,如:var express = require('express');