Changes between Version 31 and Version 32 of CodingStyle

Timestamp:

Jul 14, 2018, 6:57:27 PM (6 years ago)

Author:

davea

Comment:

--

CodingStyle

@@ -9 +9 @@
  * If code is repeated, factor it out and make it into a function.
  * If a function becomes longer than 100 lines or so, split it up.
- * If a file is becoming 'landfill', split it up.
+ * If a file is becoming 'landfill' (unrelated stuff), split it up.
  * C++ `.h` files often contain both interface and implementation. Clearly divide these.
 
 === Error codes === #error-codes
 
- * (Almost) all functions should return an integer error code.
-   Nonzero means error. See [source:boinc/lib/error_numbers.h lib/error_numbers.h] for a list of error codes.
-   The only exception to this is PHP database access functions, which use the mysql_* convention
+Most functions should return an integer error code.
+Nonzero means error. See [source:boinc/lib/error_numbers.h lib/error_numbers.h] for a list of error codes.
+Exceptions:
+ * PHP database access functions, which use the mysql_* convention
    that zero means error, and you call mysql_error() or mysql_error_string() to find details.
- * Calls to functions that return an error code should check the code.
-   Generally they should return non-zero on error, e.g.:
+ * Functions that return whether a condition holds; such functions should have
+   descriptive names like `is_job_finished()`.
+ * Functions that return a number or other type, and for which no errors are possible.
+
+Calls to functions that return an error code should check the code.
+Generally they should return non-zero on error, e.g.:
 {{{
 retval = blah();