added title, description and reference to general patterns

chuanxshi · chuanxshi · commit 0a308714cdff · 2012-01-18T23:28:37.000+08:00
diff --git a/general-patterns/access-to-global-object.html b/general-patterns/access-to-global-object.html
@@ -1,11 +1,15 @@
-<!doctype html>
+ <!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: Access to the Global Object
+ Description: access the global object without hard-coding the identifier window
+*/
+
 // access to the Global Object
 // this should work in ES3, ES5 and ES5-strict.
 var global = (function (){
diff --git a/general-patterns/avoiding-eval.html b/general-patterns/avoiding-eval.html
@@ -1,11 +1,15 @@
-<!doctype html>
+ <!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: Avoiding eval()
+ Description: avoid using eval()
+*/
+
 // antipattern
 var property = "name";
 alert(eval("obj." + property));
diff --git a/general-patterns/avoiding-implied-typecasting.html b/general-patterns/avoiding-implied-typecasting.html
@@ -1,11 +1,15 @@
-<!doctype html>
+ <!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: Implied Typecasting
+ Description: avoid implied typecasting
+*/
+
 var zero = 0;
 
 // antipattern
diff --git a/general-patterns/built-in-prototypes.html b/general-patterns/built-in-prototypes.html
@@ -1,11 +1,15 @@
-<!doctype html>
+ <!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: (Not) Augmenting Built-in Prototypes
+ Description: only augment built-in prototypes when certain conditions are met
+*/
+
 if (typeof Object.protoype.myMethod !== "function"){
 Object.protoype.myMethod = function (){
 // implementation...
diff --git a/general-patterns/conditionals.html b/general-patterns/conditionals.html
@@ -1,11 +1,15 @@
-<!doctype html>
+ <!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: Conditionals
+ Description: pattern and antipattern of using if else
+*/
+
 // NOTE: Paul Irish states that the first statement is only an antipattern when optimizing for 
 // low-bandwidth source (such as for a bookmarklet.
 // Using the first statement will generally outperform the regex in a loop, and is faster than the
diff --git a/general-patterns/for-in-loops.html b/general-patterns/for-in-loops.html
@@ -1,11 +1,15 @@
-<!doctype html>
+ <!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: for-in loops
+ Description: optimized for-in loops
+*/
+
 // the object
 var man ={
 hands: 2,
@@ -60,6 +64,9 @@
 console.log(i, ":", man[i]);
 }
 }
+
+// reference
+// http://net.tutsplus.com/tutorials/javascript-ajax/the-essentials-of-writing-high-quality-javascript/
 </script>
 </body>
 </html>
diff --git a/general-patterns/for-loops.html b/general-patterns/for-loops.html
@@ -1,11 +1,15 @@
-<!doctype html>
+ <!doctype html>
 <html lang="en">
 <head>
 <title>JavaScript Patterns</title>
 <meta charset="utf-8">
 </head>
 <body>
 <script>
+/* Title: for loops
+ Description: optimized for loops
+*/
+
 // sub-optimal loop
 for (var i = 0; i < myarray.length; i++){
 // do something with myarray[i]
@@ -36,6 +40,9 @@
 }
 
 }
+
+// reference
+// http://net.tutsplus.com/tutorials/javascript-ajax/the-essentials-of-writing-high-quality-javascript/
 </script>
 </body>
 </html>
diff --git a/general-patterns/globals.html b/general-patterns/globals.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Minimizing Globals
+ Description: create and access a global variable in a browser environment
+*/
+
 function sum(x, y){
 // antipatten: implied global
 result = x + y;
diff --git a/general-patterns/hoisting.html b/general-patterns/hoisting.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Hoisting
+ Description: var statements anywhere in a function act as if the variables were declared at the top of the function
+*/
+
 // antipattern
 myname = "global"; // global variable
 function func(){
diff --git a/general-patterns/minimizing-globals.html b/general-patterns/minimizing-globals.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Minimizing Globals
+ Description: create and access a global variable in a browser environment
+*/
+
 myglobal = "hello"; // antipattern
 console.log(myglobal); // "hello"
 console.log(window.myglobal); // "hello"
diff --git a/general-patterns/parseint.html b/general-patterns/parseint.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Number Conversions with parseInt()
+ Description: use the second radix parameter
+*/
+
 var month = "06",
 year = "09";
 month = parseInt(month, 10);
diff --git a/general-patterns/single-var-pattern.html b/general-patterns/single-var-pattern.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Single var Pattern
+ Description: use one var statement and declare multiple variables
+*/
+
 function func(){
 var a = 1,
 b = 2,
@@ -22,6 +26,9 @@
 style = el.style;
 // do something with el and style...
 }
+
+// reference
+// http://net.tutsplus.com/tutorials/javascript-ajax/the-essentials-of-writing-high-quality-javascript/
 </script>
 </body>
 </html>
diff --git a/general-patterns/switch-pattern.html b/general-patterns/switch-pattern.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: switch Pattern
+ Description: improve the readability and robustness of your switch statements
+*/
+
 var inspect_me = 0,
 result = '';
 switch (inspect_me){

-Original file line number
+Diff line change
 </head>
 <body>
 <script>
 +/* Title: Minimizing Globals
 + Description: create and access a global variable in a browser environment
 +*/
++
 myglobal="hello";// antipattern
 console.log(myglobal);// "hello"
 console.log(window.myglobal);// "hello"