FCKeditor 3.x/Design and Architecture/Coding Style - Revision history

Fredck: /* File Headers */

2012-01-02T10:23:22Z

‎File Headers

2012-01-02T10:22:23Z

‎Comments

2010-09-13T14:43:11Z

Added String Literals

2010-02-02T13:23:10Z

‎Whitespace

2010-02-02T13:21:51Z

‎Whitespace

2010-01-31T11:37:20Z

Adding two whitespaces rules.

2009-09-28T14:45:29Z

‎Layout

2009-04-09T15:20:49Z

‎General Recommendations

2009-02-17T16:12:33Z

2009-02-17T16:08:23Z

@@ Line 261: / Line 261: @@
 Here is a JavaScript template for the header to be included in the source code:
 <pre>/*
-Copyright (c) 2003-2009, CKSource - Frederico Knabben. All rights reserved.
+Copyright (c) 2003-2012, CKSource - Frederico Knabben. All rights reserved.
 For licensing, see LICENSE.html or http://ckeditor.com/license
 */

@@ Line 231: / Line 231: @@
 <pre>// This is a comment.   NOT: //This is a comment
 /**                     NOT: /**
-* This is block               *This is a block
+ * This is block              *This is a block
-* comment.                    *comment
+ * comment.                   *comment
-*/                            */
+ */                           */
 </pre>
 Note that comment blocks should be opened with two asterisks only for documentation purposes. See [[FCKeditor 3.x/Design and Architecture/Documentation#JavaScript_API|JavaScript API Documentation]].

@@ Line 245: / Line 245: @@
 </pre>
 Other than shortnesses and better readability, regular expression literals are compiled during script evaluation, which improves performance at runtime.
 == File Headers  ==

@@ Line 178: / Line 178: @@
 transformation.multiply( matrix );
 </pre>
-Second line of a multiple variables declarations should have a single tab proceeded.
 <pre>
 var example = 1,
-     sample = 2;
+    sample = 2;
 NOT
 var example = 1,
-    sample = 2;
+        sample = 2;
 </pre>

@@ Line 119: / Line 119: @@
 </pre>
 === Whitespace  ===
-"If" parentheses should be surround by whitespaces.
+"If", "for", "while" and "switch" should be followed by a white space.
-<pre>if ( true ) return;
+<pre>if ( true )
 NOT
-if( true )return;
+if( true )
 </pre>
 Conventional operators should be surrounded by a space (including ternary operators).
@@ Line 174: / Line 174: @@
 matrix.setElement( 2, 1, -sinAngle );
 matrix.setElement( 2, 2, cosAngle );
 // Apply rotation

@@ Line 86: / Line 86: @@
+}
 </pre>
-Single statement if/else/while/for could (preferably) be written without brackets, but never in the same line.
+Single statement (single line only) if/else/while/for could (preferably) be written without brackets, but never in the same line.
 <pre>if ( condition )
      statement;

@@ Line 4: / Line 4: @@
 It is quite common to take the Java style to write JavaScript code, assuming it is a "cut-down" version of Java. Although JavaScript has an indirect relation with Java, apart from the similar "C
-== General Recommendations ==
+== General Recommendations  ==
 Any violation to the guide is allowed if it enhances readability.
-If the name "FCKeditor" is used, it must always be written with "FCK" uppercased concatenated with "editor" in lowercase. The following are wrong: "FckEditor", "FCKEditor", "fckEditor", "FCK Editor", and so on. Exception is made for directory names, where all chars "should" be in lowercase.
+If the name "CKEditor" is used, if must always be written with "CKE" uppercased concatenated with "ditor" in lowercase. The following usages are wrong: "CKeditor", "ckEditor", "CK Editor", etc. Exceptions are made for directories and file names, which must always be lowercased, and the CKEDITOR namespace name.
 The name "JavaScript" should be written with both the "J" and "S" in uppercase. The following are wrong: "Javascript", "javascript", etc.

@@ Line 206: / Line 206: @@
 </pre>
-== Comments ==
+== Comments  ==
 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. Whenever possible, end comments with a period as normal phrases, and wrap comments within the first 80 characters of each line.
 There should be a space after the comment identifier.
-<pre>
+<pre>// This is a comment.   NOT: //This is a comment
 /**                     NOT: /**
 * This is block               *This is a block
@@ Line 220: / Line 219: @@
 */                            */
 </pre>
 == Regular Expressions ==

@@ Line 139: / Line 139: @@
 <pre>if ( myVar == 1 )
 </pre>
 Functions/method calls should not be followed by a space.
 <pre>doSomething( someParameter );