mirror of
https://gitlab.com/etherlab.org/ethercat.git
synced 2026-02-06 03:41:52 +08:00
56 lines
1.2 KiB
Plaintext
56 lines
1.2 KiB
Plaintext
$Id$
|
|
|
|
vim: spelllang=en tw=78
|
|
|
|
This is a short introduction to the coding style that shall be used. The below
|
|
rules are applicable for all C source files, except the Ethernet drivers, for
|
|
which the Linux Kernel coding style shall be used to minimize the
|
|
differences).
|
|
|
|
1) Line length
|
|
|
|
- Lines shall not exceed 78 characters.
|
|
|
|
2) Whitespace
|
|
|
|
- Indentation shall be done using 4 space characters
|
|
|
|
- No whitespace shall be left at the end of a line.
|
|
|
|
- After commas, colons and semicolons, a single space shall be
|
|
placed (if not followed by a line break).
|
|
|
|
- Binary operators (=, ==, ~=, |, ||, etc.) shall be enclosed by 2 spaces
|
|
(except . and ->).
|
|
|
|
3) Placing braces
|
|
|
|
- Braces shall be placed in the following way (K&R style):
|
|
|
|
if (...) {
|
|
...
|
|
} else if (...) {
|
|
...
|
|
} else {
|
|
...
|
|
}
|
|
|
|
int function(...)
|
|
{
|
|
...
|
|
}
|
|
|
|
4) Defines and Macros
|
|
|
|
- Defines and macros shall be named in CAPITAL letters. If a macro contains
|
|
multiple statements, they should be enclosed by a 'do {} while (0)' loop.
|
|
Macro parameters shall also be capital letters and shall be enclosed py
|
|
parantheses if necessary.
|
|
|
|
#define MACRO(A, B) \
|
|
do { \
|
|
if ((A) == 1) { \
|
|
statement(B); \
|
|
} while (0)
|
|
|