Booklordofthedings/Beef-Styleguide
Booklordofthedings/Beef-Styleguide
1
0
Wiki

Update Home

Booklordofthedings 2025-03-07 10:51:55 +01:00
parent 131422e700
commit 82bcdbfd5b
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
Home.md

@ -10,13 +10,17 @@ Its formatted as a list of rules to make it somewhat easier to read and understa
#### Naming
- Names are either `camelCase` or `PascalCase`
- Classes should be named in ``PascalCase`
- Classes should be named in `PascalCase`
- Structs and enums can be `camelCase` but dont have to be
*This specifically depends on their usage. If it is supposed to be treated similar to a primitive it should be camelCase, otherwise its PascalCase.
(This also means that a class that behaves like a primitive could be named in camelCase, but thats unlikely to happen in practice)*
(This also means that a class that behaves like a primitive could be named in camelCase, but thats unlikely to occur in practice)*
- Interfaces use the I[Name] syntax
*Optionally with the "-able" postfix*
- Iterators for numerical reasons should use `i`, `j`, `k`, `ii`
*Two of the same character is fine since its visibly different, but further repetition should be avoided*
- Iterators in foreach type scenarios should use the singular version of the thing they are ( `line`, `entry`, `key`)
- Other common names: `toReturn/res/result`
- Other common names: `toReturn/res/result`
- Public members, properties and functions should use `PascalCase`
- Private members or functions should use `camelCase` and prepend a `_` infront of them
- Local variables use `camelCase`
- Otherwise names should indicate what a variable is used for or what it contains