Changes between Version 7 and Version 8 of Hacking

Timestamp:

02/15/11 20:30:43 (14 years ago)

Author:

angel_il

Comment:

--

Hacking

@@ -31 +31 @@
 The lines before a comment should be empty. If the comment directly belongs to the following code, there should be no empty line after the comment, except if the comment contains a summary of multiple following code blocks.
 
+'''This is right:'''
+{{{
+    int i;
+
+    /*
+     * This is a multi line comment,
+     * Delete '\n' char.
+     * Note that edit_delete() will not corrupt anything if called while
+     *   cursor position is EOF.
+     */
+    (void) edit_delete (edit);
+
+     /*  This is a one line comment. Allocate additional memory.  */
+     mem = (char *) malloc (memneed);
+
+    /**
+     * @brief This is a doxygen comment.
+     *
+     * This is a more detailed explanation of
+     * this simple function.
+     *
+     * @param[in]   param1     The parameter value of the function.
+     *
+     * @param[out]  result1    The result value of the function.
+     *
+     * @return              0 on success and -1 on error.
+     */
+    int example(int param1, int *result1);
+}}}
+
+'''This is wrong:'''
+{{{
+    //This is a one line comment.
+
+    /*This is a one line comment.*/
+
+    /* This is a multi line comment,
+       with some more words...*/
+}}}
 
 typical structure of *.c file