Kotlin API Design Review

Naming Rules

• Clear at point of use
• Omit needless words
• lowerCamelCase: properties, functions, variables
• UpperCamelCase: classes, interfaces, objects
• UPPER_SNAKE_CASE: constants
• Booleans: is, has, can, should prefix
• Collections: plural names (users, not userList)

Common Issues

Function Design

• Named parameters for clarity beyond first param
• Default parameters at end
• Suspend functions for async operations
• Extension functions for utility methods
• Operator overloading when semantically appropriate

Return Types

• Nullable when null is meaningful
• Result for failable operations
• Flow for streams
• sealed class for finite states

Data Classes

• Use for data transfer objects
• Immutable by default (val over var)
• Copy function for updates
• Destructuring support

Severity

• 🔴 Critical: Violates conventions
• 🟡 Improvement: Could be clearer
• 🟢 Enhancement: Optional polish