Code Style

Return Home

Code Style

Create great code that's readable and maintainable

• Applies to new and edited code going forward (as of 2026/06/09)

• Follow JSF code styling for readability and maintainability

• Exceptions, our code uses this to identify functions:

  • variables: snake_case (JSF compliant)
  • functions: lower_Camel_Case (Seamly variant)
  • classes: Upper_Camel_Case (JSF compliant)

• Notable features:

  • pointers: int* correct_pointer (bind the asterisk to the type not the name)
  • braces: sit on a new line, can't be omitted
  • line limit: 120 chars max
  • indents: spaces, no tabs, for uniformity in rendering
  • comments: single line // only, not /.../ multiline to prevent accidently nesting