Skip to content

Commit

Permalink
First round of feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
ctiller committed Dec 22, 2015
1 parent f0d916a commit ff298f6
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions doc/c-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,19 @@ Header Files
------------

- Public header files (those in the include/grpc tree) should compile as pedantic C89
- Public header files should be includable from C++ programs. That is, they should
include the following:
```c
#ifdef __cplusplus
extern "C" {
# endif

/* ... body of file ... */

#ifdef __cplusplus
}
# endif
```
- Header files should be self-contained and end in .h.
- All header files should have a #define guard to prevent multiple inclusion.
To guarantee uniqueness they should be based on the file's path.
Expand All @@ -31,6 +44,17 @@ C99 Features

- Variable sized arrays are not allowed
- Do not use the 'inline' keyword
- Flexible array members are allowed (https://en.wikipedia.org/wiki/Flexible_array_member)

Comments
--------

Within public header files, only `/* */` comments are allowed.

Within implementation files and private headers, either single line `//`
or multi line `/* */` comments are allowed. Only one comment style per file is
allowed however (i.e. if single line comments are used anywhere within a file,
ALL comments within that file must be single line comments).

Symbol Names
------------
Expand Down

0 comments on commit ff298f6

Please sign in to comment.