Latest revision as of 17:19, 26 October 2022

Variable Naming Conventions

Local variable names should all be lower case:

$email

If the local variable name is made up of multiple words, use snake case:

$email_address

Function names should all be lowercase:

update

If the function name is made up of multiple words, use snake case:

update_by_id

Class names should all be capitalized:

Vertical

If the class name is made up of multiple words, use Pascal case:

VerticalGroup

@@ Line 3: / Line 3: @@
 == Local Variables ==
-Local variable names should all be lower case, ex. <pre>email</pre>
+Local variable names should all be lower case: <pre>$email</pre>
-If the local variable name is made up of multiple words, use snake case, ex. <pre>email_address</pre>
+If the local variable name is made up of multiple words, use snake case: <pre>$email_address</pre>
-=== Functions ===
+== Functions ==
-Function names should all be lowercase, ex. <pre>update</pre>
+Function names should all be lowercase: <pre>update</pre>
-If the function name is made up of multiple words, use snake case, ex. <pre>update_by_id</pre>
+If the function name is made up of multiple words, use snake case: <pre>update_by_id</pre>
-=== Classes ===
+== Classes ==
-Class names should all be capitalized, ex. <pre>Vertical</pre>
+Class names should all be capitalized: <pre>Vertical</pre>
-If the class name is made up of multiple words, use snake case, but preserving the first word capitalization, ex. <pre>Vertical_groups</pre>
+If the class name is made up of multiple words, use Pascal case: <pre>VerticalGroup</pre>