5. Patterns and code conventions

Patterns are code practices which most programs follow. Code conventions are practices which programs should follow. This chapter describes patterns and code conventions without clearly distinguishing two.

Patterns and code conventions are more than matters of preference, although they are not parts of language specification or runtime specification. Kink is a minimalist language in its specification. Thus, many aspects of programming, such as accessibility, are determined by patterns and code conventions.

• 5.1. Variables
  • 5.1.1. Member variables
  • 5.1.2. Local variables
  • 5.1.3. Multiple assignment
• 5.2. Functions
  • 5.2.1. Types of functions
  • 5.2.2. Receiver and parameters
  • 5.2.3. Function result
• 5.3. Accessibility
  • 5.3.1. Public or private
  • 5.3.2. Modules
  • 5.3.3. Data variables
  • 5.3.4. Functions and methods
• 5.4. Typing
  • 5.4.1. Typing contracts
  • 5.4.2. Type testing by intrinsic property
  • 5.4.3. Duck type testing
• 5.5. Control structure
  • 5.5.1. Branches
  • 5.5.2. Loops
  • 5.5.3. Return and break
  • 5.5.4. Release resources
• 5.6. Error handling
  • 5.6.1. Error handling approeaches
  • 5.6.2. Error result for valid input
  • 5.6.3. Exception as a panic button
  • 5.6.4. When to catch an exception
• 5.7. Naming conventions
  • 5.7.1. Words are separated by underscores
  • 5.7.2. Only the first letter of a data variable should be capitalized
  • 5.7.3. ? at the end of Bool variables and functions
• 5.8. Code style
  • 5.8.1. Indentation
  • 5.8.2. Parentheses, braces and brackets