From 131422e7007eed99ed41460fad1db9118a3249cc Mon Sep 17 00:00:00 2001 From: Booklordofthedings Date: Fri, 7 Mar 2025 10:05:26 +0100 Subject: [PATCH] Add Home --- Home.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 Home.md diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..fbcfc7a --- /dev/null +++ b/Home.md @@ -0,0 +1,22 @@ +### Beef Styleguide +This is a very basic styleguide for naming things and how to code in Beef. +Its formatted as a list of rules to make it somewhat easier to read and understand. + +
+ +**No rule is absolute and there may be legitimate reasons to break them.** + +
+ +#### Naming +- Names are either `camelCase` or `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)* +- 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