Style Guide

Misc

• Packages
  • {styler}

Naming

• Characteristics
  • Good names are a form of documentation
  • Nested loop variables should be names, not letters
  • Names should be easily searchable
  • Use prefixes and positive terms for booleans
  • Add extra detail for test functions
  • Names should be pronouncable
  • Use consistent lexicon throughout a project
• Good names are a form of documentation
  
• Nested loop variables should be names, not letters
  
• Names should be easily searchable
  
• Use prefixes and positive terms for booleans
  
• Add extra detail for test functions
  
• Names should be pronouncable
  
• Use consistent lexicon throughout a project
  

Refactoring

• Flatten nested code

  Nested

  

  Flattened

  

  • Condition on the negative