Changes between Version 11 and Version 12 of Hacking

Timestamp:

02/15/11 21:41:37 (14 years ago)

Author:

angel_il

Comment:

--

Hacking

@@ -71 +71 @@
 }}}
 
-=== Code blocks (if, for, case...) ===
+=== Conditions in Code blocks (if, for, case...) ===
 
 Always follow an 'if' keyword with a space but don't include additional
@@ -79 +79 @@
 {{{
     if (i == 0)
+
 }}}
 '''This is wrong:'''
@@ -84 +85 @@
     if ( i == 0 )
     if (0 == i)
-}}}
+
+}}}
+
+=== Functions usage ===
 
 Always insert a space between the name and left parentheses when invoking functions.
@@ -91 +95 @@
 {{{
     do_example (int param1, int *result1);
+
 }}}
 '''This is wrong:'''
 {{{
     do_example(int param1, int *result1);
-}}}
+
+}}}
+
+=== Braces ===
 
 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. 
@@ -136 +144 @@
 }}}
 
+=== Goto ===
+
 Use "goto" only when necessary. "goto"s are evil, but they can greatly enhance readability and reduce memory leaks when used as the single exit point from a function. 
 
@@ -158 +168 @@
     g_free (dest);
 }
-}}}
+
+}}}
+
+=== Readable The Code ===
 
 Use your best judgement and choose the more readable option.
+Remember that many other persons will review it:
 
 '''This is right:'''
@@ -166 +180 @@
     bytes = read (fd, &routine.pointer, sizeof (routine));
     if (bytes == -1 || (size_t) bytes < (sizeof (routine)))
+
 }}}
 
@@ -174 +189 @@
     if (read (from_parent_fd, &i, sizeof (int)) != sizeof (int))
         return NULL;
+
+}}}
+
+=== Make use of helper variables ===
+
+Please try to avoid passing function calls as function parameters in new code. This makes the code much easier to read and it's also easier to use the "step" command within gdb.
+
+'''This is right:'''
+{{{
+void
+dirsizes_cmd (void)
+{
+    WPanel *panel = current_panel;
+    int i;
+    ComputeDirSizeUI *ui;
+
+    ui = compute_dir_size_create_ui ();
+
+    compute_dir_size_destroy_ui (ui);
+
+    recalculate_panel_summary (panel);
+
+}
+
+}}}
+
+'''This is wrong:'''
+{{{
+void
+dirsizes_cmd (void)
+{
+    compute_dir_size_destroy_ui (compute_dir_size_create_ui ());
+}
 
 }}}