| Revision as of 02:41, 26 May 2003 editTakuyaMurata (talk | contribs)Extended confirmed users, IP block exemptions, Pending changes reviewers89,979 edits add break down large functions from Perl book← Previous edit | Revision as of 07:38, 26 May 2003 edit undoKorpo~enwiki (talk | contribs)109 edits Cleaned up links, bibliography and how the text related to them, broke up paragraphs, added links.Next edit → | ||
| Line 2: | Line 2: | ||
| == Refactoring Code == | == Refactoring Code == | ||
| The term refactoring is often used to describe modifying |
The term refactoring is often used to describe modifying ] without changing its external behavior, and is sometimes informally referred to as "cleaning it up." In this case, refactoring is part of the cycle of create and test code, refactor and test code, add new behavior and test code, refactor and test code, add new behavior and test code, and so on. Testing ensures that the code still does what it is supposed to. | ||
| Refactoring is the part of code maintenance which doesn't fix bugs or add new functionality. Rather it is designed to improve the understandability of the code or change its ] and ], to make it easier for human ] in the future. In particular, adding new behavior to a program might be difficult with the program's given structure, so a developer might refactor it first to make easy, and then add the new behavior. | |||
| ⚫ | An example of a trivial refactoring is to change a variable name into something more meaningful, such as from a single letter 'i' to 'interestRate'. A more complex refactoring is to turn the code within an if block into a function. An even more complex refactoring is to replace an if conditional with polymorphism. While "cleaning up" code has happened for decades, the key insight in refactoring is to intentionally "clean up" code separately from adding new functionality, using a known catalogue of common useful refactoring methods, and then separately testing the code (knowing that any behavioral changes indicate a bug). | ||
| Refactoring is done as a separate step, to simplify testing. At the end of the refactoring, any change in behavior is clearly a ] and can be fixed separately from the problem of debugging the new behavior. | |||
| ⚫ | An example of a trivial refactoring is to change a variable name into something more meaningful, such as from a single letter 'i' to 'interestRate'. A more complex refactoring is to turn the code within an if block into a ]. An even more complex refactoring is to replace an if ] with ]. While "cleaning up" code has happened for decades, the key insight in refactoring is to intentionally "clean up" code separately from adding new functionality, using a known catalogue of common useful refactoring methods, and then separately testing the code (knowing that any behavioral changes indicate a bug). The new aspect is explicitly wanting to improve an existing design without altering its intent or behavior. | ||
| Refactoring is an important aspect of ]. | Refactoring is an important aspect of ]. | ||
| The book ''Refactoring'' |
The book ''Refactoring'' is the classic reference. Although refactoring code has been done informally for years, William F. Opdyke's 1993 PhD dissertation is the first known paper to specifically examine refactoring. All of these resources provide a catalog of common methods for refactoring; a refactoring method has a description of how to apply the method and indicators for when you should (or should not) apply the method. | ||
| Refactoring is such an important concept that it has been identified as | Refactoring is such an important concept that it has been identified as | ||
| Many refactorings are meant to cure the ills listed in |
Many refactorings are meant to cure the ills listed in . | ||
| === Break down large functions === | === Break down large functions === | ||
| Line 38: | Line 42: | ||
| For policy on refactoring in Misplaced Pages, see ]. In the context of Misplaced Pages, usually ]s are refactored, but occasionally, when an article has been developed in a particularly haphazard way, it needs to be changed so radically that the resulting change can be called a refactoring. | For policy on refactoring in Misplaced Pages, see ]. In the context of Misplaced Pages, usually ]s are refactored, but occasionally, when an article has been developed in a particularly haphazard way, it needs to be changed so radically that the resulting change can be called a refactoring. | ||
| ==External links== | ==External links and bibliography== | ||
| ⚫ | |||
| ⚫ | # Martin Fowler, ''Refactoring. Improving the Design of Existing Code'', Addison-Wesley Professional 1999, ISBN 0201485672 | ||
| ==Bibliography== | |||
| ⚫ | # | ||
| ⚫ | |||
| # http://www.refactoring.com is ]s homepage about refactoring. | |||
| # William F. Opdyke's 1993 PhD dissertation at ftp://st.cs.uiuc.edu/pub/papers/refactoring/opdyke-thesis.ps.Z | |||
| # "How to Write Unmaintainable Code" by ] | |||
Revision as of 07:38, 26 May 2003
Refactoring is the process of rewriting written material to improve its readability or structure, with the explicit purpose of keeping its meaning or behavior.
Refactoring Code
The term refactoring is often used to describe modifying source code without changing its external behavior, and is sometimes informally referred to as "cleaning it up." In this case, refactoring is part of the cycle of create and test code, refactor and test code, add new behavior and test code, refactor and test code, add new behavior and test code, and so on. Testing ensures that the code still does what it is supposed to.
Refactoring is the part of code maintenance which doesn't fix bugs or add new functionality. Rather it is designed to improve the understandability of the code or change its structure and design, to make it easier for human maintenance in the future. In particular, adding new behavior to a program might be difficult with the program's given structure, so a developer might refactor it first to make easy, and then add the new behavior.
Refactoring is done as a separate step, to simplify testing. At the end of the refactoring, any change in behavior is clearly a bug and can be fixed separately from the problem of debugging the new behavior.
An example of a trivial refactoring is to change a variable name into something more meaningful, such as from a single letter 'i' to 'interestRate'. A more complex refactoring is to turn the code within an if block into a function. An even more complex refactoring is to replace an if conditional with polymorphism. While "cleaning up" code has happened for decades, the key insight in refactoring is to intentionally "clean up" code separately from adding new functionality, using a known catalogue of common useful refactoring methods, and then separately testing the code (knowing that any behavioral changes indicate a bug). The new aspect is explicitly wanting to improve an existing design without altering its intent or behavior.
Refactoring is an important aspect of extreme programming.
The book Refactoring is the classic reference. Although refactoring code has been done informally for years, William F. Opdyke's 1993 PhD dissertation is the first known paper to specifically examine refactoring. All of these resources provide a catalog of common methods for refactoring; a refactoring method has a description of how to apply the method and indicators for when you should (or should not) apply the method.
Refactoring is such an important concept that it has been identified as one of the most important software innovations.
Many refactorings are meant to cure the ills listed in .
Break down large functions
Functions that grow in use also grow in size. After a certain point, it becomes clear that functions can benefit from using functions themselves. Your eyes probe the function looking for a likely candidate to relocate elsewhere. This candidate is chosen for being the largest stretch of code that really has nothing to do with the enclosing function. This lets us easily think up a name that explains what the new function does without having to resort to something contrived just to distinguish it from the original function.
This section is originally from Perl Design Patterns Book
Refactoring other Text
The term refactoring originated in computer programming, but the concept has also been applied when modifying any text.
To refactor text, in a WikiWiki, is to rewrite and often to reorganize the text completely or radically, sometimes dramatically shortening it, but in a way that preserves all the important, relevant content. In a WikiWiki, it is usually discussions that are refactored--with the purpose of making the discussion accessible to someone who is interested in the arguments made in the discussion, and the information to be gleaned from it, rather than the history of the discussion itself. Refactoring is critically important process in developing and maintaining the Misplaced Pages.
Obviously, refactoring is difficult to do in such a way that will make all participants in a discussion happy. It requires intelligence, tact, excellent reading comprehension skills, good writing skills, and a lack of bias.
Several good discussions are found at the WikiWeb at c2.org.
For policy on refactoring in Misplaced Pages, see editing policy. In the context of Misplaced Pages, usually talk pages are refactored, but occasionally, when an article has been developed in a particularly haphazard way, it needs to be changed so radically that the resulting change can be called a refactoring.
External links and bibliography
- Martin Fowler, Refactoring. Improving the Design of Existing Code, Addison-Wesley Professional 1999, ISBN 0201485672
- What Is Refactoring (c2.com article)
- http://www.refactoring.com is Martin Fowlers homepage about refactoring.
- William F. Opdyke's 1993 PhD dissertation at ftp://st.cs.uiuc.edu/pub/papers/refactoring/opdyke-thesis.ps.Z
- "How to Write Unmaintainable Code" by Roedy Green