一.命名规范
（1）函数名 ：
驼峰式 ，以动词开始（readBook , changeBookName）
返回boolean类型的要用is开头 （ isBook() ）
（2）变量名 ：
驼峰式 , 为名词（book , bookName）
（3）常量名 ：
全部大写 （BOOK ， BOOKNAME）
二.注释
(1) 每个函数和方法
描述其目的和用于完成任务所有可能使用的算法。
陈述事先的假设也非常重要，如：参数代表什么 ， 函数是否有返回值
(2) 大段代码
用于完成单个任务的多行代码应该在前面放一个描述任务的注释
(3) 复杂的算法
如果使用一种独特的方式解决某个问题，则要注释你是如何做的
(4) hack(对代码的修改与优化)
当你要用到一些不同的方法来优化代码时，将要修改的信息放在注释中。
三.代码
1. 松散耦合
(1) 解耦HTML/JavaScript
HTML/JavaScript过度耦合时会出现的问题：出现JavaScript错误时就要先判断出这个问题时出现在HTML部分还是JavaScript部分，影响了可维护性
有一些方法会将HTML和JavaScript过于紧密地耦合在一起。要尽量 避免 这些代码。如下：
- a. 将<script>标签直接嵌套在HTML代码中
<script>
document.write("Hello");
</script>
- b. 使用事件处理程序属性值的紧密耦合的HTML、JavaScript
<input type="button" value="Click me" onclick="doSomething()" />
- c. 用innerHTML插入一段HTML文本到页面
var container=document.getElementById("container")
container.innerHTML="<p>Add message</p>";
最理想情况：HTML 和 JavaScript 应该完分离 ， 并通过外部文件和使用DOM附加行为来包含JavaScript
(2) 解耦CSS/JavaScript
少使用 类似element.style.color = "red"
而使用 element.clssName = "edit"
(3) 解耦应用逻辑/事件处理程序
三.其他
（1）变量类型透明
//通过初始化指定变量类型
var found = false; //布尔型
var count = -1; //数字
var name = ""; //字符串
var person = null; //对象
缺点：无法用于函数申明中的函数参数
网友评论