Quality in Software Development | Dennis Doomen | Beyond Coding Podcast #13

Refactoring

Refactoring is a nuanced process that requires understanding the code's behavior and intent. Dennis Doomen emphasizes the importance of naming conventions and documentation to convey the purpose of code components. He argues against the notion that code itself serves as documentation, advocating for clear comments and source control history to explain the rationale behind changes 1. Doomen also highlights the pitfalls of over-applying principles like SOLID, which can lead to overly fragmented code if not balanced correctly 2.

If you cannot actually express your intent in the code sufficiently enough, put some comments on it to explain it to the next person.

--- Dennis Doomen

Understanding the context and applying principles judiciously is key to effective refactoring.

   

Trust & Comments

Building trust in a development team is crucial, especially when refactoring code. Dennis Doomen notes that maintaining clean commits and demonstrating incremental improvements can foster trust with product owners 3. He also introduces the concept of "smell comments" as a way to flag potential issues without expanding the scope of a pull request. These comments serve as breadcrumbs for future refactoring efforts, keeping the codebase manageable and transparent 4.

You need to keep it with the source. And that works really well for me, I have to say.

--- Dennis Doomen

This approach not only aids in maintaining code quality but also in building a culture of continuous improvement.