mirror of
https://github.com/Llewellynvdm/Tomb.git
synced 2025-02-02 11:58:28 +00:00
Simple style guidelines, as discussed in ML
This commit is contained in:
parent
2b62a972f5
commit
600ffb1170
21
HACKING
Normal file
21
HACKING
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
Style guidelines
|
||||||
|
===============
|
||||||
|
|
||||||
|
Indentation
|
||||||
|
-----------
|
||||||
|
Code must be indented using four spaces.
|
||||||
|
In vim, this can be accomplished using
|
||||||
|
|
||||||
|
set shiftwidth=4
|
||||||
|
set expandtab
|
||||||
|
|
||||||
|
Naming
|
||||||
|
------
|
||||||
|
|
||||||
|
global variables should be `$UPPERCASE`.
|
||||||
|
|
||||||
|
local variables should be `$lowercase`, best if it can be written without underscores.
|
||||||
|
If you feel the need to name a variable `$longdescriptionofwhatthisisusefulfor`,
|
||||||
|
then you're allowed to use underscores. But do you really need?
|
||||||
|
|
||||||
|
functions should be lowercase+underscores: `do_this()`
|
Loading…
x
Reference in New Issue
Block a user