Gosu best practices checklist

Use the following checklist before you complete your Gosu coding tasks to ensure that your Gosu code follows Guidewire best practices.

Naming and declaration best practices

Best Practice to Follow	Best Practice Followed
Observe general Gosu naming conventions
Omit type specifications with variable initialization
Add a suffix to functions and classes to avoid name conflicts
Declare functions Private unless absolutely necessary
Use public properties instead of public variables
Do not declare static scope for mutable variables
Use extensions to add functions to entities
Match capitalization of types, keywords, and symbols

Commenting best practice

Best Practice to Follow	Best Practice Followed
Comment placement
Block comments
Javadoc comments
Single-line comments
Trailing comments
Using comment delimiters to disable code

Coding best practices

Best Practice to Follow	Best Practice Followed
Use whitespace effectively
Use parentheses effectively
Use curly braces effectively
Program defensively against conditions that can fail
Omit semicolons as statement delimiters
Observe null safety with equality operators
Use typeis expressions for automatic downcasting
Observe loop control best practices
Return from functions as early as possible

Performance best practices

Best Practice to Follow	Best Practice Followed
Use the fastest technique for string concatenation
Consider the order of terms in compound expressions
Avoid repeated method calls within an algorithm
Remove constant variables and expressions from loops
Avoid doubly nested loop constructs
Pull up multiple performance intensive method calls
Be wary of dot notation with object access paths
Avoid code that incidentally queries the database
Use comparison methods to filter queries
Use comparison methods instead of the Where method
Use Count properties on query builder results and find queries
Use activity pattern codes instead of public IDs in comparisons
Create single plugin instance