[gnome-devel-docs] programming-guidelines: Section on formatting conditions
- From: Federico Mena Quintero <federico src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-devel-docs] programming-guidelines: Section on formatting conditions
- Date: Tue, 6 Aug 2013 14:47:18 +0000 (UTC)
commit 28d087e807af1b8404368bb629a9ee22e8bc2723
Author: Federico Mena Quintero <federico gnome org>
Date: Tue Aug 6 16:39:51 2013 +0200
programming-guidelines: Section on formatting conditions
programming-guidelines/C/c-coding-style.page | 44 ++++++++++++++++++++++++++
1 files changed, 44 insertions(+), 0 deletions(-)
---
diff --git a/programming-guidelines/C/c-coding-style.page b/programming-guidelines/C/c-coding-style.page
index d788f3b..0fd4da1 100644
--- a/programming-guidelines/C/c-coding-style.page
+++ b/programming-guidelines/C/c-coding-style.page
@@ -368,5 +368,49 @@ my_function (int argument)
</code>
</section>
+ <section id="conditions">
+ <title>Conditions</title>
+
+ <p>
+ Do not check boolean values for equality. The rationale is that
+ a "true" value may not be necessarily equal to whatever the
+ <code>TRUE</code> macro uses. For example:
+ </p>
+
+ <code>
+/* invalid */
+if (condition == TRUE)
+ do_foo ();
+
+/* valid */
+if (another_condition)
+ do_bar ();</code>
+
+ <p>
+ Even if C handles NULL equality like a boolean, be explicit.
+ This makes it easier to port your C code to something like
+ C#, where testing against null explicitly is important:
+ </p>
+
+ <code>
+/* valid */
+if (some_pointer == NULL)
+ do_blah ();
+
+/* valid */
+if (something != NULL)
+ do_foo ();
+
+/* invalid */
+if (some_other_pointer)
+ do_blurp ();</code>
+
+ <!-- FIXME: gtk+/docs/CODING-STYLE mentions where to put
+ logical operators in conditiosn split over multiple
+ lines. I (Federico) disagree with this, for a good
+ reason. -->
+
+ </section>
+
</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]