Software /
code /
prosody
File
doc/coding_style.txt @ 6984:0f633160464c
mod_compression: Remove FIXMEs, mod_c2s and mod_s2s checks if TLS compression is used and sets a flag since 969e0a054795
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 10 Dec 2015 15:16:49 +0100 |
parent | 13:716632cca05d |
child | 8728:41c959c5c84b |
line wrap: on
line source
This file describes some coding styles to try and adhere to when contributing to this project. Please try to follow, and feel free to fix code you see not following this standard. == Indentation == 1 tab indentation for all blocks == Spacing == No space between function names and parenthesis and parenthesis and paramters: function foo(bar, baz) Single space between braces and key/value pairs in table constructors: { foo = "bar", bar = "foo" } == Local variable naming == In this project there are many places where use of globals is restricted, and locals used for faster access. Local versions of standard functions should follow the below form: math.random -> m_random string.char -> s_char == Miscellaneous == Single-statement blocks may be written on one line when short if foo then bar(); end 'do' and 'then' keywords should be placed at the end of the line, and never on a line by themself.