All about Refactoring - Githubissues

xp1632 / DFKI_working_log

0 stars 0 forks source link

All about Refactoring #39

Open xp1632 opened 3 months ago

xp1632 commented 3 months ago

Basic definition in Refactoring

reference : https://refactoring.guru/refactoring/what-is-refactoring

Clean Code:

simple and obvious for other programmers
no duplications in code
minimal classes
passes all tests
easier and cheaper to maintain

xp1632 commented 3 months ago

Technical debt:

unclean code slowers down the development process day by day

Cause and Harm

- Hard to divide and conqure

when the project doesn't follow the modulization rule and every component affects each other, it's hard to do refactoring or isolate the work of team members

- Lack of tests before launching - Lack of documentation

- Long-term simultaneous development in several branches

The more changes made in isolation, the greater the total technical debt.

xp1632 commented 3 months ago

When to refactor:

When you are doing the same thing for the third time, start refactoring
Or adding a feature based on others' dirty code
Or during fixing a bug

How to refactor- Checklist

Code should be cleaner
No new functionality is introduced
All tests must be passed

xp1632 commented 3 months ago

Smell bad code:

Long Method
Any method longer than ten lines of code is too long.
When you need to comment on something inside a method, better put it into a new method with a descriptive name

How to extract method:

remember to give a descriptive name for method: createOrder(), renderCustomerInfo()
isolates independent parts of code

xp1632 commented 3 months ago

I don't quite understand some rest methods for refactoring
I'll first give the whole content a quick scan

xp1632 commented 3 months ago

Creational Patterns:

Our generation pipeline is more similar to Builder
https://refactoring.guru/design-patterns/builder
we create the components we need and ensemble them at last

!!! Structural Design Patterns:

!!! very important

reference: https://refactoring.guru/design-patterns/structural-patterns

We should provide a simple interface to a complex subsystem

Adapter/Wrapper:

what we do is also like a wrapper, to provide conversion behind scene to fit the requirement in the other side

xp1632 commented 3 months ago

Refactoring Methods

Extract expressions to variables
https://refactoring.guru/extract-variable

https://refactoring.guru/smells/comments
replaces too many comments by variables or method with descriptive name

https://refactoring.guru/pull-up-field

https://refactoring.guru/substitute-algorithm

https://refactoring.guru/consolidate-conditional-expression

xp1632 commented 3 months ago

Problematic Code:

https://refactoring.guru/smells/dead-code

Delete dead code

https://refactoring.guru/smells/duplicate-code

Extract method or pull up the common part

https://refactoring.guru/smells/divergent-change

split the behavior of classes

https://refactoring.guru/smells/inappropriate-intimacy

Reason, problematic class definition, a good class should know as little about each other as possible

https://refactoring.guru/smells/speculative-generality

do not leave too much just in case or future features code