Parker2991/Funkin
1
0
Fork 0
mirror of https://github.com/FunkinCrew/Funkin.git synced 2024-11-14 11:15:24 -05:00
Code Issues Projects Releases Packages Wiki Activity

Fix typos in CODESTYLE.md

Browse source
This commit is contained in:
Hundrec 2024-10-04 22:13:02 -07:00 committed by Eric
parent 6848815e80
commit 7d5d80d515
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CODESTYLE.md
View file

@ -4,14 +4,14 @@ Code style is enforced using Visual Studio Code extensions.
## .hx ## .hx
Formatting is handled by the `nadako.vshaxe` extension, which includes Haxe Formatter. Formatting is handled by the `nadako.vshaxe` extension, which includes Haxe Formatter.
Haxe Formatter automatically resolves issues such as intentation style and line breaks, and can be configured in `hxformat.json`. Haxe Formatter automatically resolves issues such as indentation style and line breaks, and can be configured in `hxformat.json`.
Code Quality is handled by the `vshaxe.haxe-checkstyle` extension, which includes Haxe Checkstyle. Code Quality is handled by the `vshaxe.haxe-checkstyle` extension, which includes Haxe Checkstyle.
### Haxe Checkstyle Notes ### Haxe Checkstyle Notes
* Checks can be escalated to display as different serverities in the Problems window. * Checks can be escalated to display as different severities in the Problems window.
* Checks can be disabled by setting the severity to `IGNORE`. * Checks can be disabled by setting the severity to `IGNORE`.
* `IndentationCharacter` checks what is used to indent, `Indentation` checks how deep the intentation is. * `IndentationCharacter` checks what is used to indent, `Indentation` checks how deep the indentation is.
* `CommentedOutCode` check is in place because old code should be retrieved via Git history. * `CommentedOutCode` check is in place because old code should be retrieved via Git history.
* TODO items: Enable these one-by-one and fix them to improve the overall code quality. * TODO items: Enable these one-by-one and fix them to improve the overall code quality.
- Reconfigure `MethodLength` - Reconfigure `MethodLength`