From: bangerth Date: Wed, 31 Aug 2011 13:00:07 +0000 (+0000) Subject: Add a link. Fix a duplicate word. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=8fe43d42a0fd1947c019931b38af7d6ed3522ea4;p=dealii-svn.git Add a link. Fix a duplicate word. git-svn-id: https://svn.dealii.org/trunk@24228 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/doc/doxygen/headers/coding_conventions.h b/deal.II/doc/doxygen/headers/coding_conventions.h index 9136b101b5..1382e47390 100644 --- a/deal.II/doc/doxygen/headers/coding_conventions.h +++ b/deal.II/doc/doxygen/headers/coding_conventions.h @@ -2,7 +2,7 @@ // $Id$ // Version: $Name$ // -// Copyright (C) 1998, 2007, 2008 by the deal.II authors +// Copyright (C) 1998, 2007, 2008, 2011 by the deal.II authors // // This file is subject to QPL and may not be distributed // without copyright and license information. Please refer @@ -13,7 +13,7 @@ /** * @page CodingConventions Coding conventions used throughout deal.II - + Throughout deal.II, we strive to keep our programming style and the kind of interfaces we provide as consistent as possible. To this end, we have adopted a set of coding conventions that we attempt to follow wherever possible. They @@ -28,18 +28,18 @@ because some things become clear already by looking at the style a piece of code is written, without having to look up the exact definition of something.

Style issues

- +
  1. %Functions which return the number of something (number of cells, - degrees of freedom, etc) should start with n_*. Example: + degrees of freedom, etc) should start with n_*. Example: SparsityPattern::n_nonzero_entries().
  2. %Function which set a bit or flag should start with set_*; functions which clear bits of flags should be named clear_*. Example: CellIterator::set_refine_flag().
    3. -
  3. In the implementation files, after each function, at least three - empty lines are expected to +
  4. In the implementation files, after each function, at least three + empty lines are expected to enable better readability. One empty line occurs in functions to group blocks of code, two empty lines are not enough to visibly distinguish sufficiently that the code belongs to two different functions.
    5. @@ -73,7 +73,7 @@ code is written, without having to look up the exact definition of something. block of public functions, beginning with the constructors, then the destructors. If there are public member variables, these have to occur before the constructor. Public variables shall only be - used if constant (in particular if they are static and constant) + used if constant (in particular if they are static and constant) or unavoidable.
    After the public members, the protected and finally the private @@ -86,7 +86,7 @@ code is written, without having to look up the exact definition of something.
  5. If a function has both input and output parameters, usually the input parameters shall precede the output parameters, unless there are good reasons to change this order. (The most common reason is trailing - input parameters with default default values.)
    6. + input parameters with default values.)
  6. Exceptions are used for %internal parameter checking and for consistency checks through the Assert macro. Exception handling @@ -96,7 +96,9 @@ code is written, without having to look up the exact definition of something. in any case, not only in debug mode.
  7. Classes and types generally are named using uppercase letters to denote - word beginnings (e.g. TriaIterator) while functions and variables + word beginnings (e.g. TriaIterator) — sometimes called + camel + case — while functions and variables use lowercase letters and underscores to separate words. The only exception are the iterator typedefs in Triangulation and DoFHandler (named cell_iterator, active_line_iterator, etc) @@ -191,12 +193,12 @@ we list here: calls to the Assert macro are removed from the program in optimized mode (which you presumably only use once you know that everything runs just fine in debug mode. The optimized libraries are faster by a factor of - 3-5 than the debug libraries, at the price that it's much harder to find + 3-5 than the debug libraries, at the price that it's much harder to find bugs.
    8. -
  8. Assert postconditions: If a function computes something - non-trivial there may be a bug in the code. To find these, use +
  9. Assert postconditions: If a function computes something + non-trivial there may be a bug in the code. To find these, use postconditions: just like you have certain knowledge about useful values for input parameters, you have knowledge about what you expect possible return values to be. For example, a function that computes the norm of @@ -258,7 +260,7 @@ we list here: that these problems are easily found.
    10. -
  10. Initialize variables at the point of their declaration if they +
  11. Initialize variables at the point of their declaration if they live on the stack: Traditional C required that variables are declared at the beginning of the function even if they are only used further below. This leads to @@ -279,7 +281,7 @@ we list here: The problem is that if the code between the declaration and initialization is long and complicated, you can't look up on one page what the type of - a variable is and what it's value may be. In fact, it may not even be + a variable is and what it's value may be. In fact, it may not even be quite clear that the variable is used initialized at all, or whether it is accidentally left uninitialized.

    @@ -307,7 +309,7 @@ we list here:

    As a final note, it is clear that you can only do this sort of stuff for variables that completely live on the stack without allocating memory - on the heap. Within deal.II, this is only true for builtin types like + on the heap. Within deal.II, this is only true for builtin types like int, double, char, etc, as well as the Point and Tensor classes. Everything else has something like a std::vector as a member variable, which requires memory allocation — you don't @@ -340,7 +342,7 @@ we list here: ... - This was most likely meant to be a == rather than an + This was most likely meant to be a == rather than an assignment. By marking the variable as const, the compiler would have told us about this bug. Maybe equally importantly, human readers of the code need not look further down whether the value of the variable may @@ -366,11 +368,11 @@ we list here: Here, the user calls cell-@>child(3), for example. There really is no reason why the function would ever want to change the value of - the child_no argument — so mark it as constant: + the child_no argument — so mark it as constant: this both helps the reader of the code understand that this is an input argument of the function for which we need not search below whether it is ever changed, and it helps the compiler help us finding bugs if we ever accidentally change the value.

- + */