mirror of
https://git.planet-casio.com/Slyvtt/Collab_RPG.git
synced 2024-12-29 13:03:43 +01:00
33 lines
885 B
Markdown
33 lines
885 B
Markdown
# Style guidelines in Collab RPG
|
|
|
|
(Mibi88) Fcalva, SlyVTT: What do you think of this?
|
|
|
|
Wrap the code on 80 columns. Align the wrapped code with the last parantheses,
|
|
etc.
|
|
|
|
Use curly braces with if, else, while and for statements if they can't hold on a
|
|
single line.
|
|
|
|
Put the curly braces after if, else, while or for statements and declarations of
|
|
procedures on the same line.
|
|
|
|
No spaces around parantheses, one space after a comma.
|
|
|
|
Variables names in sneak_case.
|
|
|
|
(Mibi88) SlyVTT, Fcalva, should be use a doc generation thing or do we describe
|
|
the procedures as I did so far?
|
|
|
|
Document your procedures as following:
|
|
|
|
```C
|
|
/* procedure_name()
|
|
*
|
|
* Describe what this procedure does.
|
|
* arg1: Describe this argument. If the text is too long, wrap it to the
|
|
* next line like this.
|
|
* long_name: Describe this argument, and so on.
|
|
*/
|
|
```
|
|
|
|
Have I forgotten something?
|