How do you deal with magic numbers and hard-coded values in your code?

In my experience, avoiding magic numbers and hard-coded values is crucial. They make code harder to read and maintain. Using named constants improves clarity, making code self-explanatory and adaptable. It fosters collaboration by ensuring everyone understands the values' significance, leading to better-quality code. In my current role, I introduced an "Automatic Test Requirements" document. It emphasizes avoiding hard-coded values in tests, urging the use of descriptive variables, constants, and configuration files instead.

Magic numbers and hard-coded values are fine when building out an initial spike or quick proof of concept; however, the moment the spike is validated as being useful, it's time to refactor. One major issue with leaving magic numbers and hard-coded values littered throughout the code is that eventually, even you, the person who wrote them, will forget why you put them there or why you choose that particular value.

I fully recognize that sometimes, magic numbers are avoidable. However, I always request a comment to accompany the literal - and if possible I like to organize all of them in a central location or a configuration file.

Additionally, use an internationalization (i18n) framework such as i18next instead of hard-coding prose or formatting for date, time, numbers and currency.

When reviewing magic numbers and hard-coded values in code, identify them and assess their purpose. Magic numbers should be replaced with named constants to improve readability and maintainability. Evaluate the context to understand why these values are used; if they are configuration or environment-specific, consider externalizing them to configuration files or environment variables. Check for repeated hard-coded values, which may indicate a need for centralization to avoid duplication and facilitate easier updates. Ensure that the use of such numbers or values is justified and documented, especially if they are critical to the application's logic or configuration.

To avoid magic numbers and hard-coded values, use named constants to make the code more readable and maintainable. Define these constants in a centralized location, such as a configuration file or constants class, to facilitate easy updates and reuse. When dealing with values that may change based on the environment or context, utilize configuration files, environment variables, or external data sources. This approach not only eliminates hard-coded values but also enhances flexibility and scalability. Encourage regular code reviews to identify and refactor any magic numbers or hard-coded values into appropriately named entities, ensuring that the codebase remains clean and understandable.

When dealing with magic numbers and hard-coded values in your code, it's crucial to adopt best practices that not only improve code maintainability but also enhance overall system robustness. - Use Configuration Files: Storing values in configuration files allows for easy updates without modifying the code. - Environment Variables: For values that differ between environments (development, testing, production), using environment variables ensures that the right values are applied without code changes. - Constants and Enums: Defining constants and enums in code provides clarity and reduces errors.