Meaningful Naming in Code

Introduction

Welcome to the second lesson of the "Clean Code Basics in PHP" course, focused on meaningful naming . In the previous lesson, we introduced clean code and its significance in developing maintainable and efficient software. Now, let's explore the importance of meaningful naming — an essential part of clean code. Selecting appropriate names is vital for creating code that is clear, understandable, and easy to maintain.

Good Naming at a Glance

In this lesson, we'll cover the following naming guidelines: Reveal Intent Through Names : Ensure names clearly convey the role and functionality of variables, classes, and methods. For instance, replacing $calc with $calculateInterest enhances code clarity. 🧠 Avoid Misleading Names : Avoid names that imply incorrect assumptions, such as using $users_list for a set, ensuring accuracy and understanding. 🚫 Choose Descriptive, Searchable Names : Opt for names like $age instead of $a, facilitating easy searchability and recognition within the codebase, which enhances maintainability. 🔍 Name Interfaces and Implementations Wisely : Move away from outdated naming conventions like IUserService; use clear names such as UserService that reflect purpose without redundancy. Consistent Naming Across the Codebase : Use uniform patterns like getAllUsers instead of varied terms such as fetchAllUsers, maintaining clarity and preventing confusion. 📚 Provide Sufficient Context in Names : Include enough context, such as using $fileSize instead of $size, to eliminate ambiguity, especially when components are used across different contexts. 🌐

Reveal Intent Through Names

Names should clearly express the purpose and functionality of your variables, classes, and methods, leaving no room for ambiguity. Bad Example Good Example class MyClass {} class UserService {} $coll; $users; $calc; $calculateInterest; $temp; $temporaryFile; $proc; $processOrder; Effective names provide immediate insight into what the code does, reducing the need for additional explanations. For example, replacing $coll with $users instantly conveys the collection's purpose.

Avoid Misleading Names

Avoid using names that may lead others to incorrect assumptions about the type or purpose of a variable or method. Bad ExampleGood ExampleExplanation$users_list = Set();$users = Set();The name suggests a list, but it's actually a set.function saveUser() {}function saveUserAndSendEmailConfirmation() {}The method name doesn't convey that it also sends an email confirmation.$temp;$temperature;The name "temp" could be misinterpreted as "temporary."

Bad Example	Good Example	Explanation
`$users_list = Set();`	`$users = Set();`	The name suggests a list, but it's actually a set.
`function saveUser() {}`	`function saveUserAndSendEmailConfirmation() {}`	The method name doesn't convey that it also sends an email confirmation.
`$temp;`	`$temperature;`	The name "temp" could be misinterpreted as "temporary."

Choose Descriptive, Searchable Names

Names should be easily searchable within the codebase. Using short names, even if they might seem descriptive in certain contexts, generally hinders maintainability and readability. For example, opting for $numberOfItems instead of $num makes the code easier to search and understand.

Name Interfaces and Implementations Wisely

In PHP, while interfaces can be named freely without enforcing strict conventions, it's important to select names that clearly indicate their functionality. For example, instead of using legacy conventions like IUserService, simply using UserService for an interface is preferable. For class implementations, names like InMemoryUserService or DbUserService effectively communicate their specific roles or strategies.

Consistent Naming Across the Codebase

Consider method names such as fetchAllUsers, retrieveTasks, loadUsers, and fetchEveryTodoItem . Is anything wrong with these names? They do convey intent and are descriptive, so they appear fine. However, using these varied names within the same codebase is problematic due to inconsistency . In the same codebase, it's beneficial to stick to a single naming pattern, like getAll, to avoid confusion and maintain clarity, e.g., getAllUsers, getAllTasks, getAllTodoItems .

Provide Sufficient Context in Names

When discussing good naming, consider the context in which a name is used. The variable name $size might be perfectly acceptable within the resizeArray method. However, in the context of generateReport, the name is too vague, and renaming this variable to something more descriptive like $numberOfPages is advisable. Providing enough context is crucial, but avoid giving too much context. For instance, within the UserService method, save is a perfectly acceptable name, and there's no need for an excessively lengthy name like saveAllUsers .

Summary

Meaningful naming is a critical aspect of writing clean code. By choosing names that clearly express intent, avoiding misleading terms, and maintaining consistency and context, you create code that is easy to read, understand, and maintain. Up next, you'll have the opportunity to refactor code, applying these principles and honing your ability to write intuitive, clean code.

Join the 1M+ learners on CodeSignal

Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal