commit 0a482bbbfe1dbabaab6b7a5c26ec4f29f0c618d9 (tree) parent 2ed949a6ae053262ee563b198a8758ba82f50e84 Author: Andrew Kelley <superjoe30@gmail.com> Date: Thu, 11 Aug 2016 21:13:02 -0700 add style guide Diffstat:
| A | doc/style.md | | | 16 | ++++++++++++++++ |
1 file changed, 16 insertions(+), 0 deletions(-)
diff --git a/doc/style.md b/doc/style.md @@ -0,0 +1,16 @@ +# Official Style Guide + +These conventions are not enforced by the compiler, but they are shipped in +this documentation along with the compiler in order to provide a point of +reference, should anyone wish to point to an authority on agreed upon Zig +coding style. + + * 4 space indentation + * `camelCaseFunctionName` + * `TitleCaseTypeName` + * `snake_case_variable_name` + * Open braces on same line, unless you need to wrap. + * If a list of things is longer than 2, put each item on its own line and + exercise the abilty to put an extra comma at the end. + +See Zig standard library for examples.