[gnome-devel-docs] programming-guidelines: add book references for writing good code

commit 4e0347f53a873e101fc862f90b712b16a1710d32
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu Apr 16 17:02:56 2015 +0200

    programming-guidelines: add book references for writing good code
    When possible, the link is the official web page for the book. As a
    fallback, a link to wikipedia (if a page exists) or Amazon.
    If only one book should be chosen for "writing good code" (the subject
    of the page), it should be Code Complete IMHO. It covers a wide range of
    subjects, from single lines of code to the general architecture of big
    programs, with introductory chapters on other topics like refactoring,
    debugging, performances, etc.
    The Refactoring and Design Patterns books are also the references for
    those subjects, which are important for code quality and
    Finally, Object-Oriented Design Heuristics is also a really good book,
    that contains many guidelines for writing OO code. It's IMHO a more
    important book than Design Patterns, although the latter is more
    well-known. The guidelines explained in the book apply to every OO code,
    even for a small codebase. On the other hand some design patterns are
    useful only for big codebases. Since every software must begin by a
    small codebase, it's better to apply OO best-practices from the

 programming-guidelines/C/writing-good-code.page |   25 +++++++++++++++++++++++
 1 files changed, 25 insertions(+), 0 deletions(-)
diff --git a/programming-guidelines/C/writing-good-code.page b/programming-guidelines/C/writing-good-code.page
index 907dacb..b6c02a1 100644
--- a/programming-guidelines/C/writing-good-code.page
+++ b/programming-guidelines/C/writing-good-code.page
@@ -121,4 +121,29 @@
+  <section id="book-references">
+    <title>Book References</title>
+    <list>
+      <item><p>
+        <link href="http://www.cc2e.com";>Code Complete</link>, by Steve McConnell.
+      </p></item>
+      <item><p>
+        <link href="http://martinfowler.com/books/refactoring.html";>
+          Refactoring: Improving the Design of Existing Code
+        </link>, by Martin Fowler.
+      </p></item>
+      <item><p>
+        <link href="http://en.wikipedia.org/wiki/Design_Patterns";>
+          Design Patterns: Elements of Reusable Object-Oriented Software
+        </link>, by Erich Gamma, Richard Helm, Ralph Johnson and John Vlissides.
+      </p></item>
+      <item><p>
+        <link href="http://astore.amazon.com/gnomestore-20/detail/020163385X";>
+          Object-Oriented Design Heuristics
+        </link>, by Arthur Riel.
+      </p></item>
+    </list>
+  </section>

[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]