view mcabber/CodingStyle.txt @ 1678:e489ead6574a

New help system * Configurable multiple help location directories * Multiple languages support * Utilizing option guards to be configurable dynamically * Language autodetection from locale with fallback to 'en'
author Myhailo Danylenko <isbear@ukrpost.net>
date Mon, 18 Jan 2010 18:49:25 +0200
parents 189ffdd944b4
children ffd0e57e9563
line wrap: on
line source

This document describes the preferred coding style for the mcabber project.

If you intend to patch and contribute to mcabber, please try to use the
existing style, and read the following points.

- Do not use tabs, use space characters;
- Avoid trailing whitespace;
- Avoid lines longer than 80 characters;
- Indentation is 2 spaces (ok, maybe it isn't a good idea but it's the
  current style);
- Put a space after non-functions statements (e.g. if, while...)
- Put the opening brace last on the same line, and put the closing brace first
  except for functions, where the opening brace should be alone on a new line.

  Example:

    void example(void)
    {
      if (cond1) {
        do_a();
      } else if (cond2) {
        do_b();
      } else {
        do_c();
      }

      if (error)
        exit(0);
    }

 - Look at existing code for rules not mentioned here.

Mikael