Changes between Version 8 and Version 9 of Hacking

Timestamp:

02/15/11 21:10:43 (13 years ago)

Author:

angel_il

Comment:

--

Hacking

@@ -3 +3 @@
 
  * Maximum Line Width is 100 Characters.  The reason is not about people with low-res screens but rather sticking to 100 columns prevents you from easily nesting more than one level of if statements or other code blocks.
- * Use 4 Space Tabs to Indent.  With whitespace fillers.
+ * Use 4 Space Tabs with whitespace fillers to Indent. Never use tabs.
  * No Trailing Whitespace 
  * Follow the GNU-Style guidelines.  We won't go through all of them here.
@@ -33 +33 @@
 '''This is right:'''
 {{{
-    int i;
-
     /*
      * This is a multi line comment,
@@ -58 +56 @@
      * @return              0 on success and -1 on error.
      */
-    int example(int param1, int *result1);
+    int example (int param1, int *result1);
+
 }}}
 
@@ -69 +68 @@
     /* This is a multi line comment,
        with some more words...*/
+
+}}}
+
+=== Code blocks (if, for, case...)===
+
+Always follow an 'if' keyword with a space but don't include additional
+spaces following or preceding the parentheses in the conditional.
+
+This is right:
+{{{
+    if (i == 0)
+}}}
+This is wrong:
+{{{
+    if ( i == 0 )
+    /* 
+    if (0 == i)
+}}}
+
+Always insert a space between the name and left parentheses when invoking functions.
+
+This is right:
+{{{
+    do_example (int param1, int *result1);
+}}}
+This is wrong:
+{{{
+    do_example(int param1, int *result1);
+}}}
+
+
+
+Braces for code blocks used by '''for, if, switch, while, do..while''', etc. should begin on the next line after the statement keyword and end on a line of their own. 
+
+Functions are different and the beginning left brace should be located in the first column on the next line.
+
+If the beginning statement has to be broken across lines due to length, the beginning brace should be on a line of its own.
+
+This is right:
+{{{
+    if (xterm_flag && xterm_title)
+    {
+        path = strip_home_and_password (current_panel->cwd);
+    ...
+    }
+
+    for (j = 0; j < 10; j++)
+    {
+        for (i = 0; str_options[i].opt_name != NULL; i++)
+            g_free (*str_options[i].opt_addr);
+    }
+
+}}}
+This is wrong:
+{{{
+    if (xterm_flag && xterm_title) {
+        path = strip_home_and_password (current_panel->cwd);
+    ...
+    }
+
+    if (xterm_flag && xterm_title)
+    {
+        path = strip_home_and_password (current_panel->cwd); }
+
+    for (k = 0; k < 10; k++)
+        for (j = 0; j < 10; j++)
+            for (i = 0; str_options[i].opt_name != NULL; i++)
+                g_free (*str_options[i].opt_addr);
+
 }}}