mirror
/
Shipwright
mirror of https://github.com/HarbourMasters/Shipwright.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Specified main categories for #region comments.

This commit is contained in:
Malkierian 2023-11-13 14:27:15 -07:00
parent ca976df770
commit 814356b56f
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/CONTRIBUTING.md
View File

@ -63,7 +63,7 @@ If you wanted to modify this block with an enhancement to add difficulty options
}
```
Incorporate as much of the section as is applicable in a block behind a CVar, with comment mentioning what type of addition it is (enhancement/fix/restoration, etc), label the else block as vanilla code, and put a closing comment at the end. Then, make your changes in the if block. In this instance, it ended up looking like this:
Incorporate as much of the section as is applicable in a block behind a CVar, with comment mentioning what type of addition it is (main categories are `Enhancement`, `Cheat`, `Randomizer`, or `Debug`), and put the `// #endregion` comment before the else block. Then, make your changes in the if block. In this instance, it ended up looking like this:
```c++
if (CVarGetInteger("gCustomizeFrogsOcarinaGame", 0) == 1) {