201283
I started picking up MML. I'm probably not the only one doing this, but for this kind of things I like to put a lot of comments in my code. Here is an example of my SuperC song template:
The problem is that I'm conflicted about whether I should keep this kind of comments or not in any future XHB entry.
Maybe we can use this thread to agree on a good practice regrading this issue.
EDIT: I promise this template looks better in an actual text editor ;D
// INSTRUMENTS------------------------------------------------------------------
// - P1: file name
// - P2: pitch magnification | base: 1 | range: 0 - 255
// - P3: tuning | base: 0 | range: -128 - 127
// - P4: detune | base: 0 | range: -128 - 127
// - P5: ADSR/GAIN mode | ADSR: 1 | GAIN: 0
// - P6: attack rate | fastest: 15 | range: 0-15
// - P7: decay rate | fastest: 15 | range: 0-15
// - P8: sustain level | loudest: 15 | range: 0-15
// - P9: sustain rate | no decay: 0 | range: 0-31
// - P10: release rate | no decay: 0 | range: 0-31
//-----FILE NAME___________________, P2, P3, P4, P5, P6, P7, P8, P9, P10------
#tone "brr/strings_1.brr" , 1, 0, 0, 1, 15, 15, 15, 0, 15 // @0
// PATTERN DATA-----------------------------------------------------------------
#track 1
V255 v255 t150
@0 p31 l1 k16
o5c^^^^^
The problem is that I'm conflicted about whether I should keep this kind of comments or not in any future XHB entry.
- On the one hands, I think it really makes the code more readable, plus the bit of documentation would probably be useful for people who want to learn using the related MML compiler
- On the other hand, I'm afraid reusing the same template multiple times would compromise the entries' anonymity
Maybe we can use this thread to agree on a good practice regrading this issue.
EDIT: I promise this template looks better in an actual text editor ;D