naming-review

Code review for naming conventions analyzes function, variable, and class names to detect jargon, ambiguity, and AI-generated antipatterns before a pull request. It enforces principles like "Say What It Does" and consistent verb and noun usage to improve code clarity and maintainability.

Common AI-generated naming antipatterns include enterprise suffixes and generic -er names that reduce code clarity. Identifying these naming smells during code review ensures names follow established patterns and clearly describe what the code does without ambiguity or unnecessary jargon.

Ensure consistent naming patterns across functions and variables by checking adherence to standard verb and noun usage, such as consistent get and set or create and delete pairs. Consistency checks verify that function, variable, and configuration key names follow established patterns throughout the project.

You can review configuration key names for ambiguity and jargon alongside standard code elements. The analysis applies clarity principles to configuration keys, ensuring they avoid internal jargon and adhere to best practices just like function, variable, class, and file names.

The best way to refactor code names to say what they do is applying the "Say What It Does" principle during a dedicated naming review. This identifies unclear abbreviations and ambiguous terms, ensuring function and variable names accurately describe their behavior and improve overall code quality.