Software /
code /
prosody
File
doc/coding_style.txt @ 3266:a06120464079
commit d2fb8a5ff43fcf3e94e5e518aba175503590ecda
Author: Brian Cully <bjc@kublai.com>
Date: Mon Jun 14 17:30:52 2010 -0400
Install adhoc submodules
author | Matthew Wild <mwild1@gmail.com> |
---|---|
date | Mon, 14 Jun 2010 23:51:11 +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.