From 82bcdbfd5b747b9ed7f6a0f02b0a15b03e9dea1e Mon Sep 17 00:00:00 2001 From: Booklordofthedings Date: Fri, 7 Mar 2025 10:51:55 +0100 Subject: [PATCH] Update Home --- Home.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Home.md b/Home.md index fbcfc7a..a7eb535 100644 --- a/Home.md +++ b/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` \ No newline at end of file +- 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 \ No newline at end of file