Clean code with practices and examples. The slide shows smells and heuristics in your code

1. Clean Code
Smells and Heuristics

2. Agenda
1. Comments
2. Names
3. Functions
4. Environments
5. General

3. Comments

4. Smell

5. Inappropriate Information

6. Smell

7. Obsolete Comment

8. Smell

9. Redundant Comment

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

12. Commented-out code

13. Names

14. Smell

15. Choose Descriptive Names

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

52. Avoid Negative Conditionals

53. Smell

54. Functions Should Do One Thing

55. Smell

56. Hidden Temporal Couplings

57. Smell

58. Encapsulate Boundary Conditions

59. Smell

60. Avoid Transitive Navigation