Changes between Version 12 and Version 13 of CodingGuidelines

Timestamp:

Mar 29, 2012, 10:42:21 AM (13 years ago)

Author:

FrederikHeber

Comment:

Added section on using the logger

CodingGuidelines

@@ -146 +146 @@
 
 Although in general, we do not want to rely to heavily on other libraries (because of licenses), do not reimplement the wheel if what you need is found in STL or [http://www.boost.org/ boost] which both are (quasi) standards.
+
+=== Use the logger, not cout/cerr === #code-good-bad-logger
+
+__Don't use__ '''std::cout''' or '''std::cerr''' (except maybe for internal tests which never make it into a commit). 
+
+__Always use__
+{{{
+#include "CodePatterns/Log.hpp"
+
+  ...
+  LOG(1, "INFO: Variable bla contains " << bla << ".");
+  ...
+  ELOG(1, "Variable is " << bla << " which is invalid!");
+  ...
+}}}
+
+This way we can control the verbosity of the code easily and we do not end up with many commented-out wasteland alike ''... //std::cout << "Variable bla is " << ...''.