blob: 0109819d5a606e97decfd670aa71378f32e6a51d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
|
OpenMPT Style Guide
===================
### OpenMPT
**Note:**
**This applies to all source code *except* for `libopenmpt/` and `openmpt123/`**
**directories.**
**Use libopenmpt style otherwise.**
(see below for an example)
* Place curly braces at the beginning of the line, not at the end
* Generally make use of the custom index types like `SAMPLEINDEX` or
`ORDERINDEX` when referring to samples, orders, etc.
* When changing playback behaviour, make sure that you use the function
`CSoundFile::IsCompatibleMode()` so that modules made with previous versions
of MPT still sound correct (if the change is extremely small, this might be
unnecessary)
* `CamelCase` function and variable names are preferred.
#### OpenMPT code example
~~~~{.cpp}
void Foo::Bar(int foobar)
{
while(true)
{
// some code
}
}
~~~~
|