Conventions used within TOTEM offline software

I'm mentioning here only a few basic rules. Those are not meant to make your life more complicated, on contrary, the aim is to make the work of our international team as smooth and synergetic as possible.

Coding conventions

  1. Use indentation We've agreed on using the GNU style. For details, examples and convenient tools have a look at indentation page.
  2. Document your code Perhaps, the easist and the most convenient way is to use Doxygen styled comments (from which our Doxygen documentation is compiled). The best place where to put your documentation are header files - you can easily document your class and its members. Please try to use a form which easily readable also without Doxygen. Please, take a few minutes of your time to write down (at least) a simple documentation - it will help your colleagues by a great deal.
  3. Try to prefer English over your mother tongue when making comments, naming files etc. Not everyone speaks your mother tongue.

Repository conventions

Prior to committing any modifications to the repository, check the following points.

  1. Make sure that your code is working (or it gets compiled at least).
  2. Make sure that your code is sufficiently documented.

Having committed your modifications, please, try to update your local copy from SVN and make sure the code still gets compiled. This is a check whether your commit operation has been complete and successful (it happened to me that I committed only a fraction of affected files etc.)

-- JanKaspar - 14 Jul 2009

This topic: TOTEM > WebLeftBar > CompOfflineSw > CompConventions
Topic revision: r2 - 2009-12-27 - LeszekGrzanka
This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2021 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback