aboutsummaryrefslogtreecommitdiff
path: root/STYLE
blob: 311848a5669c43350f076e9e1f0658a6a1d935c8 (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
This file summarize the C style used for Jim.
Copyright (C) 2005 Salvatore Sanfilippo.

-----------
INDENTATION
-----------

indentation is 4 spaces, no smart-tabs are used (i.e.
two indentation steps of 4 spaces will not be converted
into a real tab, but 8 spaces).

---------------
FUNCTIONS NAMES
---------------

Functions names of exported functions are in the form:

Jim_ExportedFunctionName()

The prefix is "Jim_", every word composing the function name
is capitalized.

Non exported functions are also capitalized, but in such
a case the prefix is just "Jim", like in

JimNotExportedFunction()

---------------
VARIABLES NAMES
---------------

Global variables follow the same names convention of functions.

Local variables have usually short names. A counter is just 'i', or 'j',
or something like this. When a longer name is required, composed of
more words, capitalization is used, but the first word starts in
lowcase:

thisIsALogVarName

----------
C FEATURES
----------

Only C89 ANSI C is allowed. C99 features can't be used currently.