Changes between Version 4 and Version 5 of CodingStyle

Timestamp:

Aug 25, 2007, 11:36:51 PM (17 years ago)

Author:

Frederico Caldeira Knabben

Comment:

Added Regular Expressions

CodingStyle

@@ -255 +255 @@
 Tricky code should not be commented but rewritten: In general, the use of comments should be minimized by making the code self-documenting by appropriate name choices and an explicit logical structure.
 
-All comments should be written in English.
+All comments should be written in English. Whenever possible, end comments with a period as normal phrases, and wrap long comments inside 80 characters for each line.
 
 There should be a space after the comment identifier.
 
 {{{
-    // This is a comment     NOT: //This is a comment 
+    // This is a comment.    NOT: //This is a comment 
     /**                      NOT: /** 
      * This is block               *This is a block 
-     * comment                     *comment 
+     * comment.                    *comment 
      */                            */
 }}}
 
+== Regular Expressions ==
+
+The '''regular expression literal''' should be used whenever possible, instead of the RegExp object, which should be used only when the regular expression pattern is not constant or depends on runtime computation.
+
+{{{
+    /^foo\s*/i
+    NOT
+    new RegExp( '^foo\s*', 'i' )
+}}}
+
+Other than shortnesses and better readability, regular expression literals are compiled during script evaluation, which improves performance.
+
 ----