From dd094a1c6598648c013ae1483c303eea34fc3bbe Mon Sep 17 00:00:00 2001 From: Michal Zima Date: Mon, 6 Jul 2009 13:46:10 +0200 Subject: Handbook extented with new Code style section --- handbook/codestyle | 57 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 handbook/codestyle (limited to 'handbook/codestyle') diff --git a/handbook/codestyle b/handbook/codestyle new file mode 100644 index 0000000..38237e1 --- /dev/null +++ b/handbook/codestyle @@ -0,0 +1,57 @@ +~~~ Code style ~~~ +- based on K&R conventions +- line length: 80 characters +- comments: /* like this */ + + +%%% If statements +if (var <= 64) { + return TRUE; +} else if (var - vor >= 64 && + var + vor <= 128) { + return TRUE; +} else { + return FALSE; +} + + +%%% Switch statement +/* between case blocks could be one empty line if they are enough big */ +switch (var) { + case 10: + return 3; + break; + case 20: + return 30; + break; + default: + return 0; + break; +} + + +%%% Header files +#ifndef FOO_H +#define FOO_H + +#include +#include "bar.h" + +#define FOO 1 +#define BAR 2 + +typedef struct foobar_struct { + int foo; + char *bar; +} foobar_t; + +typedef struct { + int foo; + char *bar; +} barfoo_t; + +/* breaking lines only when longer than 80 characters or for special purposes */ +extern foobar_t* foo_new(int faa, int fae, + char *bor, char *ber); + +#endif /* FOO_H */ -- cgit v1.2.3