Naming Conventions

• camelCase for variables, functions, methods, and parameters
• PascalCase for classes, interfaces, types, and enums
• All code and comments must be in English
• Names must reveal intent: getUserById instead of get, calculateTotalPrice instead of calc
• Boolean variables/methods use prefixes: isActive, hasPermission, canEdit, shouldRetry
• Avoid cryptic abbreviations: transaction instead of tx, configuration instead of cfg
• Collections should be plural: users, orderItems, activeConnections

Documentation

• Every method must have JSDoc comments including:
  • Description of what the method does
  • @param tags with types and descriptions for all parameters
  • @returns tag with type and description of the return value
  • @throws tag documenting any exceptions the method may throw

Example: