added comments to function patterns

chuanxshi · chuanxshi · commit 9b9a243b2fdf · 2012-01-15T06:44:32.000+08:00
diff --git a/function-patterns/callback.html b/function-patterns/callback.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Callback patterns
+   Description: when you pass function A to function B as a parameter, function A is a callback function
+*/
+
 var findNodes = function (callback) {
 	var i = 100000,
 		nodes = [],
diff --git a/function-patterns/configuration-objects.html b/function-patterns/configuration-objects.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Configuration objects
+   Description: keep control of function arguments and makes it easily configurable
+*/
+
 var conf = {
   username: "shichuan",
   first: "Chuan",
diff --git a/function-patterns/currying.html b/function-patterns/currying.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Currying
+   Description: used to create new functions dynamically by partially applying a set of arguments
+*/
+
 /***
  function application
  ***/
diff --git a/function-patterns/immediate-functions.html b/function-patterns/immediate-functions.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Immediate functions
+   Description: syntax that enables function execution as soon as it is defined
+*/
+
 (function () {
   console.log('watch out!');
 }());
diff --git a/function-patterns/immediate-object-initialization.html b/function-patterns/immediate-object-initialization.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Immediate object initialization
+   Description: this pattern is mainly suitable for one-off tasks
+*/
+
 ({
   // here you can define setting values
   // a.k.a. configuration constants
diff --git a/function-patterns/init-time-branching.html b/function-patterns/init-time-branching.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Init-time branching
+   Description: branch code once during initlization initialization
+*/
+
 // BEFORE
 /* var utils = {
   addListener: function (el, type, fn) {
diff --git a/function-patterns/memoization.html b/function-patterns/memoization.html
@@ -6,73 +6,75 @@
 </head>
 <body>
 <script>
-  // antipattern
-  // reason see: https://github.com/shichuan/javascript-patterns/issues/6
-  var myFunc = function (param) {
-    if (!myFunc.cache[param]) {
-      var result = {};
-      // ... expsensive operation ...
-      myFunc.cache[param] = result;
-    }
-    return myFunc.cache[param];
-  };
+/* Title: Memoization
+   Description: use function properties to avoid repeated computation
+*/
+
+// antipattern
+// reason see: https://github.com/shichuan/javascript-patterns/issues/6
+var myFunc = function (param) {
+  if (!myFunc.cache[param]) {
+    var result = {};
+    // ... expsensive operation ...
+    myFunc.cache[param] = result;
+  }
+  return myFunc.cache[param];
+};
   
-  // cache storage
-  myFunc.cache = {};
+// cache storage
+myFunc.cache = {};
   
   
-  // preferred
+// preferred method 1
+// only one argument using param
+
+var myFunc = function (param) {
+  if (!myFunc.cache.hasOwnProperty(param)) {
+    var result = {};
+    // ... expsensive operation ...
+    myFunc.cache[param] = result;
+  }
+  return myFunc.cache[param];
+};
   
-  /*
-  only one argument using param
-  */
-  var myFunc = function (param) {
-    if (!myFunc.cache.hasOwnProperty(param)) {
-      var result = {};
-      // ... expsensive operation ...
-      myFunc.cache[param] = result;
-    }
-    return myFunc.cache[param];
-  };
+// cache storage
+myFunc.cache = {};
   
-  // cache storage
-  myFunc.cache = {};
   
+// preferred method 2
+// multiple arguments using JSON stringify
+
+var myFunc = function () {
+  var cachekey = JSON.stringify(Array.prototype.slice.call(arguments)),
+                 result;
+  if (!myFunc.cache[cachekey]) {
+    result = {};
+    // ... expensive operation ...
+    myFunc.cache[cachekey] = result;
+  }
+  return myFunc.cache[cachekey];
+};
   
-  /*
-  multiple arguments using JSON stringify
-  */
-  var myFunc = function () {
-    var cachekey = JSON.stringify(Array.prototype.slice.call(arguments)),
-                   result;
-    if (!myFunc.cache[cachekey]) {
-      result = {};
-      // ... expensive operation ...
-      myFunc.cache[cachekey] = result;
-    }
-    return myFunc.cache[cachekey];
-  };
+// cache storage
+myFunc.cache = {};
   
-  // cache storage
-  myFunc.cache = {};
   
+// preferred method 3
+// multiple arguments using arguments.callee
+
+var myFunc = function (param) {
+  var f = arguments.callee,
+      result;
+  if (!f.cache[param]) {
+    result = {};
+    // ... expensive operation ...
+    f.cache[param] = result;
+  }
+  return f.cache[param];
+};
   
-  /*
-  multiple arguments using arguments.callee
-  */
-  var myFunc = function (param) {
-    var f = arguments.callee,
-        result;
-    if (!f.cache[param]) {
-      result = {};
-      // ... expensive operation ...
-      f.cache[param] = result;
-    }
-    return f.cache[param];
-  };
-  
-  // cache storage
-  myFunc.cache = {};
+// cache storage
+myFunc.cache = {};
 </script>
 </body>
 </html>
diff --git a/function-patterns/returning-functions.html b/function-patterns/returning-functions.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Returning functions
+   Description: one function returns another function or create another function on-demand
+*/
+
 var setup = function () {
   console.log(1);
   return function () {
diff --git a/function-patterns/self-defining-functions.html b/function-patterns/self-defining-functions.html
@@ -6,6 +6,10 @@
 </head>
 <body>
 <script>
+/* Title: Self-defining functions
+   Description: self-overwrite with new bodies to do less work from the second invocation and after
+*/
+
 var scareMe = function () {
   alert("Boo!");
   scareMe = function () {
diff --git a/function-patterns/self-overwrite.html b/function-patterns/self-overwrite.html
@@ -6,6 +6,7 @@
 </head>
 <body>
 <script>
+
 function next() {
   var count = 1;
   next = function() {
