Clean code - smells and heuristics
0 likes1,368 views
The document discusses code smells and heuristics for clean code. It covers smells and best practices for comments, naming conventions, functions, environments, and general coding practices. Specific smells addressed include inappropriate, obsolete, redundant comments, commented out code, non-descriptive names, dead functions, builds/tests requiring multiple steps, overridden safeties, artificial and temporal coupling, negative conditionals, functions that do more than one thing, hidden dependencies, and failure to encapsulate boundary conditions.
Clean code - smells and heuristics
- 1. Clean Code Smells and Heuristics
- 2. Agenda 1. Comments 2. Names 3. Functions 4. Environments 5. General
- 3. Comments
- 4. Smell
- 6. Smell
- 8. Smell
- 10. Poorly Written Comment - Choose your words carefully - Use correct grammar and punctuation - Don’t ramble. Don’t state the obvious. Be brief.
- 11. Smell
- 13. Names
- 14. Smell
- 16. Use Standard Nomenclature Where Possible - Names are easier to understand if they are based on existing convention or usage
- 17. Smell
- 18. Smell
- 19. Smell
- 20. Functions
- 21. Smell
- 22. Smell
- 23. Smell
- 24. Dead functions Methods that are never called should be discarded. Keeping dead code around is wasteful.
- 25. Environments
- 26. Environments - Build Requires More Than One Step - Tests Require More Than One Step
- 27. General
- 28. Smell
- 29. Smell
- 30. Smell
- 31. Overridden Safeties - Don’t turn-off warning compiler - Don’t disable or remove fail test cases
- 32. Smell
- 33. Smell
- 34. Smell
- 35. Smell
- 36. Smell
- 37. Smell
- 38. Artificial Coupling - General enums should not be contained within more specific classes - Static function
- 39. Smell
- 40. Smell
- 41. Smell
- 42. Smell
- 43. Smell
- 44. Smell
- 45. Smell
- 46. Smell
- 47. Smell
- 48. Smell
- 49. Smell
- 50. Smell
- 51. Smell
- 53. Smell
- 54. Functions Should Do One Thing
- 55. Smell
- 57. Smell
- 59. Smell