summaryrefslogtreecommitdiffstats
path: root/HACKING
blob: 00af80e132217548e6a208f6e27625613c0ff9f9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
============
Coding Style
============

- Use explicit ``!= NULL``, ``!= 0``, etc. This makes code easier to read
  and remove warnings on some platform. Don't forget SPACES before and
  after the comparison operator.

  Examples:
    BAD:
            ``if (a)``
    BAD:
            ``if (a!=NULL)``
    GOOD:
            ``if (a != NULL)``
    GOOD:
            ``if (a != 0)``

- Put figure brackets ``{}`` even if you have only one operator
  in ``if``, ``for``, etc. This also makes code easier to read and 
  saves a lot of time when you need to quickly change something. 

  Examples:
    BAD:
      .. line-block::

         if (a != NULL)
           message(G_LOG_LEVEL_MESSAGE, "Ko");
    GOOD:
      .. line-block::

         if (a != NULL) {
           message(G_LOG_LEVEL_MESSAGE, "Ok");
         }

- Put SPACES before the opening round bracket and after the closing round
  bracket with ``if``, ``for``, ``switch``, ``while``, etc. One more time,
  it improves the readability of the code.

  Examples:
    BAD:
      .. line-block::

         if(a != NULL){
           message(G_LOG_LEVEL_MESSAGE, "Ko");
         }
    GOOD:
      .. line-block::

         if (a != NULL) {
           message(G_LOG_LEVEL_MESSAGE, "Ok");
         }

- Use round brackets ``()`` for ``return``. 

  Examples:
    BAD:
            ``return 0;``
    GOOD:
            ``return(0);``

- Check for memory leaks.
  I recommend valgrind (http://valgrind.kde.org) utility with options:
    --leak-check=yes
    --show-reachable=yes
    --num-callers=32
    --suppressions=tests/valgrind/openssl.supp