Code Complete

Chia sẻ: Danh Ngoc | Ngày: | Loại File: PDF | Số trang:0

Thêm vào BST

Báo xấu

266
lượt xem 83
download

Download Vui lòng tải xuống để xem tài liệu đầy đủ

FRONT MATTER Preface [Preface] Who Should Read This Book? Where Else Can You Find This Information? Key Benefits of This Handbook Why This Handbook Was Written Book Website Author Note Notes about the Second Edition [new] Acknowledgments [n/a] LAYING THE FOUNDATION Welcome to Software Construction [1] 1.1 What Is Software Construction? 1.2 Why Is Software Construction Important? 1.3 How to Read This Book Metaphors for a Richer Understanding of Software Development [2] 2.1 The Importance of Metaphors 2.2 How to Use Software Metaphors 2.3 Common Software Metaphors Measure Twice, Cut Once: Upstream Prerequisites [3] 3.1 Importance of Prerequisites 3.2 Determine...

Chủ đề:

Bình luận(0) Đăng nhập để gửi bình luận!

Lưu

Nội dung Text: Code Complete

Code Complete Contents Page 1 FRONT MATTER Preface [Preface] Who Should Read This Book? Where Else Can You Find This Information? Key Benefits of This Handbook Why This Handbook Was Written Book Website Author Note Notes about the Second Edition [new] Acknowledgments [n/a] LAYING THE FOUNDATION Welcome to Software Construction [1] 1.1 What Is Software Construction? 1.2 Why Is Software Construction Important? 1.3 How to Read This Book Metaphors for a Richer Understanding of Software Development [2] 2.1 The Importance of Metaphors 2.2 How to Use Software Metaphors 2.3 Common Software Metaphors Measure Twice, Cut Once: Upstream Prerequisites [3] 3.1 Importance of Prerequisites 3.2 Determine the Kind of Software You’re Working On 3.3 Problem-Definition Prerequisite 3.4 Requirements Prerequisite 3.5 Architecture Prerequisite 3.6 Amount of Time to Spend on Upstream Prerequisites Key Construction Decisions [3+new material] 4.1 Choice of Programming Language 4.2 Programming Conventions 4.3 Your Location on the Technology Wave 4.4 Selection of Major Construction Practices CREATING HIGH QUALITY CODE Design in Construction [mostly new material, some from 7] 5.1 Design Challenges 5.2 Key Design Concepts 5.3 Design Building Blocks: Heuristics 5.4 Design Practices © Steven C. McConnell. All Rights Reserved. 1/12/2004 3:43 PM H:\BOOKS\codec2ed\Toc-Detailed.doc
Code Complete Contents Page 2 5.5 Comments on Popular Methodologies Working Classes [mostly new material, a little from 6] 6.1 Class Foundations: Abstract Data Types (ADTs) 6.2 Good Class Interfaces 6.3 Design and Implementation Issues 6.4 Reasons to Create a Class 6.5 Language-Specific Issues 6.6 Beyond Classes: Packages High-Quality Routines [5] 7.1 Valid Reasons to Create a Routine 7.2 Design at the Routine Level 7.3 Good Routine Names 7.4 How Long Can a Routine Be? 7.5 How to Use Routine Parameters 7.6 Special Considerations in the Use of Functions 7.7 Macro Routines and Inline Routines Defensive Programming [5.6 + new material] 8.1 Protecting Your Program From Invalid Inputs 8.2 Assertions 8.3 Error Handling Techniques 8.4 Exceptions 8.5 Barricade Your Program to Contain the Damage Caused by Errors 8.6 Debugging Aids 8.7 Determining How Much Defensive Programming to Leave in Production Code 8.8 Being Defensive About Defensive Programming The Pseudocode Programming Process [4+new material] 9.1 Summary of Steps in Building Classes and Routines 9.2 Pseudocode for Pros 9.3 Constructing Routines Using the PPP 9.4 Alternatives to the PPP VARIABLES General Issues in Using Variables [10] 10.1 Data Literacy 10.2 Making Variable Declarations Easy 10.3 Guidelines for Initializing Variables 10.4 Scope 10.5 Persistence 10.6 Binding Time 10.7 Relationship Between Data Types and Control Structures 10.8 Using Each Variable for Exactly One Purpose © Steven C. McConnell. All Rights Reserved. 1/12/2004 3:43 PM H:\BOOKS\codec2ed\Toc-Detailed.doc
Code Complete Contents Page 3 The Power of Variable Names [9] 11.1 Considerations in Choosing Good Names 11.2 Naming Specific Types of Data 11.3 The Power of Naming Conventions 11.4 Informal Naming Conventions 11.5 Standardized Prefixes 11.6 Creating Short Names That Are Readable 11.7 Kinds of Names to Avoid Fundamental Data Types [11] 12.1 Numbers in General 12.2 Integers 12.3 Floating-Point Numbers 12.4 Characters and Strings 12.5 Boolean Variables 12.6 Enumerated Types 12.7 Named Constants 12.8 Arrays 12.9 Creating Your Own Types Unusual Data Types [11.9, 10.6] 13.1 Structures 13.2 Pointers 13.3 Global Data STATEMENTS Organizing Straight-Line Code [13] 14.1 Statements That Must Be in a Specific Order 14.2 Statements Whose Order Doesn’t Matter Using Conditionals [14] 15.1 if Statements 15.2 case Statements Controlling Loops [15] 16.1 Selecting the Kind of Loop 16.2 Controlling the Loop 16.3 Creating Loops Easily—from the Inside Out 16.4 Correspondence Between Loops and Arrays Unusual Control Structures [16] 17.1 Multiple Returns from a Routine 17.2 Recursion 17.3 goto 17.4 Perspective on Unusual Control Structures © Steven C. McConnell. All Rights Reserved. 1/12/2004 3:43 PM H:\BOOKS\codec2ed\Toc-Detailed.doc
Code Complete Contents Page 4 Table-Driven Methods [12.2] 18.1 General Considerations in Using Table-Driven Methods 18.2 Direct Access Tables 18.3 Indexed Access Tables 18.4 Stair-Step Access Tables 18.5 Other Examples of Table Lookups General Control Issues [17] 19.1 Boolean Expressions 19.2 Compound Statements (Blocks) 19.3 Null Statements 19.4 Taming Dangerously Deep Nesting 19.5 A Programming Foundation: Structured Programming 19.6 Control Structures and Complexity CODE IMPROVEMENTS The Software-Quality Landscape [23] 20.1 Characteristics of Software Quality 20.2 Techniques for Improving Software Quality 20.3 Relative Effectiveness of Quality Techniques 20.4 When to Do Quality Assurance 20.5 The General Principle of Software Quality Collaborative Construction [24] 21.1 Overview of Collaborative Development Practices 21.2 Pair Programming 21.3 Formal Inspections 21.4 Other Kinds of Collaborative Development Practices Developer Testing [25] 22.1 Role of Developer Testing in Software Quality 22.2 Recommended Approach to Developer Testing 22.3 Bag of Testing Tricks 22.4 Typical Errors 22.5 Test-Support Tools 22.6 Improving Your Testing 22.7 Keeping Test Records Debugging [26] 23.1 Overview of Debugging Issues 23.2 Finding a Defect 23.3 Fixing a Defect 23.4 Psychological Considerations in Debugging 23.5 Debugging Tools—Obvious and Not-So-Obvious Refactoring [Mostly new material; some from 30] © Steven C. McConnell. All Rights Reserved. 1/12/2004 3:43 PM H:\BOOKS\codec2ed\Toc-Detailed.doc
Code Complete Contents Page 5 24.1 Kinds of Software Evolution 24.2 Introduction to Refactoring 24.3 Reasons to Refactor 24.4 Specific Refactorings 24.5 Refactoring Safely 24.6 Refactoring Strategies Code-Tuning Strategies [28] 25.1 Performance Overview 25.2 Introduction to Code Tuning 25.3 Kinds of Fat and Molasses 25.4 Measurement 25.5 Iteration 25.6 Summary of the Approach to Code Tuning Code-Tuning Techniques [29] 26.1 Logic 26.2 Loops 26.3 Data Transformations 26.4 Expressions 26.5 Routines 26.6 Recoding in Assembler 26.7 The More Things Change, the More They Stay the Same SYSTEM CONSIDERATIONS How Program Size Affects Construction [21] 27.1 Communication and Size 27.2 Range of Project Sizes 27.3 Effect of Project Size on Errors 27.4 Effect of Project Size on Productivity 27.5 Effect of Project Size on Development Activities Managing Construction [22, and some from 27.4] 28.1 Encouraging Good Coding 28.2 Configuration Management 28.3 Estimating a Construction Schedule 28.4 Measurement 28.5 Treating Programmers as People 28.6 Managing Your Manager Integration [27] 29.1 Importance of the Integration Approach 29.2 Integration Frequency—Phased or Incremental? 29.3 Incremental Integration Strategies 29.4 Daily Build and Smoke Test © Steven C. McConnell. All Rights Reserved. 1/12/2004 3:43 PM H:\BOOKS\codec2ed\Toc-Detailed.doc
Code Complete Contents Page 6 Programming Tools [20] 30.1 Design Tools 30.2 Source-Code Tools 30.3 Executable-Code Tools 30.4 Tool-Oriented Environments 30.5 Building Your Own Programming Tools 30.6 Tool Fantasyland SOFTWARE CRAFTSMANSHIP Layout and Style [18] 31.1 Layout Fundamentals 31.2 Layout Techniques 31.3 Layout Styles 31.4 Laying Out Control Structures 31.5 Laying Out Individual Statements 31.6 Laying Out Comments 31.7 Laying Out Routines 31.8 Laying Out Classes Self-Documenting Code [19] 32.1 External Documentation 32.2 Programming Style as Documentation 32.3 To Comment or Not to Comment 32.4 Keys to Effective Comments 32.5 Commenting Techniques Personal Character [31] 33.1 Isn’t Personal Character Off the Topic? 33.2 Intelligence and Humility 33.3 Curiosity 33.4 Intellectual Honesty 33.5 Communication and Cooperation 33.6 Creativity and Discipline 33.7 Laziness 33.8 Characteristics That Don’t Matter As Much As You Might Think 33.9 Habits Themes in Software Craftsmanship [32] 34.1 Conquer Complexity 34.2 Pick Your Process 34.3 Write Programs for People First, Computers Second 34.4 Program Into Your Language, Not In It 34.5 Focus Your Attention with the Help of Conventions 34.6 Program in Terms of the Problem Domain 34.7 Watch for Falling Rocks © Steven C. McConnell. All Rights Reserved. 1/12/2004 3:43 PM H:\BOOKS\codec2ed\Toc-Detailed.doc
Code Complete Contents Page 7 34.8 Iterate, Repeatedly, Again and Again 34.9 Thou Shalt Rend Software and Religion Asunder Where to Find More Information [33] 35.1 Information About Software Construction 35.2 Topics Beyond Construction 35.3 Periodicals 35.4 A Software Developer’s Reading Plan 35.5 Joining a Professional Organization © Steven C. McConnell. All Rights Reserved. 1/12/2004 3:43 PM H:\BOOKS\codec2ed\Toc-Detailed.doc
de Complete Notes about the Second Edition Page i 1 Notes about the Second 2 Edition 3 When I wrote Code Complete, First Edition, I knew that programmers needed a 4 comprehensive book on software construction. I thought a well-written book 5 could sell twenty to thirty thousand copies. In my wildest fantasies (and my 6 fantasies were pretty wild), I thought sales might approach one hundred thousand 7 copies. 8 Ten years later, I find that CC1 has sold more than a quarter million copies in 9 English and has been translated into more than a dozen languages. The success 0 of the book has been a pleasant surprise. 1 Comparing and contrasting the two editions seems like it might produce some 2 insights into the broader world of software development, so here are some 3 thoughts about the second edition in a Q&A format. 4 Why did you write a second edition? Weren’t the principles in the first 5 edition supposed to be timeless? 6 I’ve been telling people for years that the principles in the first edition were still 7 95 percent relevant, even though the cosmetics, such as the specific 8 programming languages used to illustrate the points, had gotten out of date. I 9 knew that the old-fashioned languages used in the examples made the book 0 inaccessible to many readers. 1 Of course my understanding of software construction had improved and evolved 2 significantly since I published the first edition manuscript in early 1993. After I 3 published CC1 in 1993, I didn’t read it again until early 2003. During that 10 4 year period, subconsciously I had been thinking that CC1 was evolving as my 5 thinking was evolving, but of course it wasn’t. As I got into detailed work on the 6 second edition, I found that the “cosmetic” problems ran deeper than I had 7 thought. CC1 was essentially a time capsule of programming practices circa 8 1993. Industry terminology had evolved, programming languages had evolved, 9 my thinking had evolved, but for some reason the words on the page had not. 0 After working through the second edition, I still think the principles in the first 1 edition were about 95 percent on target. But the book also needed to address new 2 content above and beyond the 95 percent, so the cosmetic work turned out to be 3 more like reconstructive surgery than a simple makeover.
de Complete Notes about the Second Edition Page ii 4 Does the second edition discuss object-oriented programming? 5 Object-oriented programming was really just creeping into production coding 6 practice when I was writing CC1 in 1989-1993. Since then, OO has been 7 absorbed into mainstream programming practice to such an extent that talking 8 about “OO” these days really amounts just to talking about programming. That 9 change is reflected throughout CC2. The languages used in CC2 are all OO 0 (C++, Java, and Visual Basic). One of the major ways that programming has 1 changed since the early 1990s is that a programmer’s basic thought unit is now 2 the classes, whereas 10 years ago the basic thought unit was individual routines. 3 That change has rippled throughout the book as well. 4 What about extreme programming and agile development? Do you talk 5 about those approaches? 6 It’s easiest to answer that question by first saying a bit more about OO. In the 7 early 1990s, OO represented a truly new way of looking at software. As such, I 8 think some time was needed to see how that new approach was going to pan out. 9 Extreme programming and agile development are unlike OO in that they don’t 0 introduce new practices as much as they shift the emphasis that traditional 1 software engineering used to place on some specific practices. They emphasize 2 practices like frequent releases, refactoring, test-first development, and frequent 3 replanning, and de-emphasize other practices like up-front planning, up-front 4 design, and paper documentation. 5 CC1 addressed many topics that would be called “agile” today. For example, 6 here’s what I said about planning in the first edition: 7 “The purpose of planning is to make sure that nobody 8 starves or freezes during the trip; it isn’t to map out each step 9 in advance. The plan is to embrace the unexpected and 0 capitalize on unforeseen opportunities. It’s a good approach 1 to a market characterized by rapidly changing tools, 2 personnel, and standards of excellence.” 3 Much of the agile movement originates from where CC1 left off. For example, 4 here’s what I said about agile approaches in 1993: 5 “Evolution during development is an issue that hasn’t 6 received much attention in its own right. With the rise of code- 7 centered approaches such as prototyping and evolutionary 8 delivery, it’s likely to receive an increasing amount of 9 attention.”
de Complete Notes about the Second Edition Page iii 0 “The word “incremental” has never achieved the 1 designer status of “structured” or “object-oriented,” so no 2 one has ever written a book on “incremental software 3 engineering.” That’s too bad because the collection of 4 techniques in such a book would be exceptionally potent.” 5 Of course evolutionary and incremental development approaches have become 6 the backbone of agile development. 7 What size project will benefit from Code Complete, Second Edition? 8 Both large and small projects will benefit from Code Complete, as will business- 9 systems projects, safety-critical projects, games, scientific and engineering 0 applications—but these different kinds of projects will emphasize different 1 practices. The idea that different practices apply to different kinds of software is 2 one of the least understood ideas in software development. Indeed, it appears not 3 to be understood by many of the people writing software development books. 4 Fortunately, good construction practices have more in common across types of 5 software than do good requirements, architecture, testing, and quality assurance 6 practices. So Code Complete can be more applicable to multiple project types 7 than books on other software development topics could be. 8 Have there been any improvements in programming in the past 10 years? 9 Programming tools have advanced by leaps and bounds. The tool that I described 0 as a panacea in 1993 is commonplace today. 1 Computing power has advanced extraordinarily. In the performance tuning 2 chapters, CC2’s disk access times are comparable to CC1’s in-memory access 3 times, which is a staggering improvement. As computers become more powerful, 4 it makes sense to have the computer do more of the construction work. 5 CC1’s discussion of non-waterfall lifecycle models was mostly theoretical—the 6 best organizations were using them, but most were using either code and fix or 7 the waterfall model. Now incremental, evolutionary development approaches are 8 in the mainstream. I still see most organizations using code and fix, but at least 9 the organizations that aren’t using code and fix are using something better than 0 the waterfall model. 1 There has also been an amazing explosion of good software development books. 2 When I wrote the first edition in 1989-1993, I think it was still possible for a 3 motivated software developer to read every significant book in the field. Today I 4 think it would be a challenge even to read every good book on one significant 5 topic like design, requirements, or management. There still aren’t a lot of other 6 good books on construction, though.
de Complete Notes about the Second Edition Page iv 7 Has anything moved backwards? 8 There are still far more people who talk about good practices than who actually 9 use good practices. I see far too many people using current buzzwords as a cloak 0 for sloppy practices. When the first edition was published, people were claiming, 1 “I don’t have to do requirements or design because I’m using object-oriented 2 programming.” That was just an excuse. Most of those people weren’t really 3 doing object-oriented programming—they were hacking, and the results were 4 predictable, and poor. Right now, people are saying “I don’t have to do 5 requirements or design because I’m doing agile development.” Again, the results 6 are easy to predict, and poor. 7 Testing guru Boris Beizer said that his clients ask him, “How can I revolutionize 8 and transform my software development without changing anything except the 9 names and putting some slogans up on the walls?” (Johnson 1994b). Good 0 programmers invest the effort to learn how to use current practices. Not-so-good 1 programmers just learn the buzzwords, and that’s been a software industry 2 constant for a half century. 3 Which of the first edition’s ideas are you most protective of? 4 I’m protective of the construction metaphor and the toolbox metaphor. Some 5 writers have criticized the construction metaphor as not being well-suited to 6 software, but most of those writers seem to have simplistic understandings of 7 construction (You can see how I’ve responded to those criticisms in Chapter 2.) 8 The toolbox metaphor is becoming more critical as software continues to weave 9 itself into every fiber of our lives. Understanding that different tools will work 0 best for different kinds of jobs is critical to not using an axe to cut a stick of 1 butter and not using a butter knife to chop down a tree. It’s silly to hear people 2 criticize software axes for being too bureaucratic when they should have chosen 3 butter knives instead. Axes are good, and so are butter knives, but you need to 4 know what each is used for. In software, we still see people using practices that 5 are good practices in the right context but that are not well suited for every single 6 task. 7 Will there be a third edition 10 years from now? 8 I’m tired of answering questions. Let’s get on with the book!
de Complete . Preface Page i 1 2 Preface 3 The gap between the best software engineering practice 4 and the average practice is very wide—perhaps wider than in 5 any other engineering discipline. A tool that disseminates 6 good practice would be important. 7 —Fred Brooks 8 MY PRIMARY CONCERN IN WRITING this book has been to narrow the gap 9 between the knowledge of industry gurus and professors on the one hand and 0 common commercial practice on the other. Many powerful programming 1 techniques hide in journals and academic papers for years before trickling down 2 to the programming public. 3 Although leading-edge software-development practice has advanced rapidly in 4 recent years, common practice hasn’t. Many programs are still buggy, late, and 5 over budget, and many fail to satisfy the needs of their users. Researchers in both 6 the software industry and academic settings have discovered effective practices 7 that eliminate most of the programming problems that were prevalent in the 8 nineties. Because these practices aren’t often reported outside the pages of highly 9 specialized technical journals, however, most programming organizations aren’t 0 yet using them in the nineties. Studies have found that it typically takes 5 to 15 1 years or more for a research development to make its way into commercial 2 practice (Raghavan and Chand 1989, Rogers 1995, Parnas 1999). This handbook 3 shortcuts the process, making key discoveries available to the average 4 programmer now. 5 Who Should Read This Book? 6 The research and programming experience collected in this handbook will help 7 you to create higher-quality software and to do your work more quickly and with 8 fewer problems. This book will give you insight into why you’ve had problems 9 in the past and will show you how to avoid problems in the future. The 0 programming practices described here will help you keep big projects under 1 control and help you maintain and modify software successfully as the demands 2 of your projects change.
de Complete . Preface Page ii 3 Experienced Programmers 4 This handbook serves experienced programmers who want a comprehensive, 5 easy-to-use guide to software development. Because this book focuses on 6 construction, the most familiar part of the software lifecycle, it makes powerful 7 software development techniques understandable to self-taught programmers as 8 well as to programmers with formal training. 9 Self-Taught Programmers 0 If you haven’t had much formal training, you’re in good company. About 50,000 1 new programmers enter the profession each year (BLS 2002), but only about 2 35,000 software-related degrees are awarded each year (NCES 2002). From 3 these figures it’s a short hop to the conclusion that most programmers don’t 4 receive a formal education in software development. Many self-taught 5 programmers are found in the emerging group of professionals—engineers, 6 accountants, teachers, scientists, and small-business owners—who program as 7 part of their jobs but who do not necessarily view themselves as programmers. 8 Regardless of the extent of your programming education, this handbook can give 9 you insight into effective programming practices. 0 Students 1 The counterpoint to the programmer with experience but little formal training is 2 the fresh college graduate. The recent graduate is often rich in theoretical 3 knowledge but poor in the practical know-how that goes into building production 4 programs. The practical lore of good coding is often passed down slowly in the 5 ritualistic tribal dances of software architects, project leads, analysts, and more- 6 experienced programmers. Even more often, it’s the product of the individual 7 programmer’s trials and errors. This book is an alternative to the slow workings 8 of the traditional intellectual potlatch. It pulls together the helpful tips and 9 effective development strategies previously available mainly by hunting and 0 gathering from other people’s experience. It’s a hand up for the student making 1 the transition from an academic environment to a professional one. 2 Where Else Can You Find This Information? 3 This book synthesizes construction techniques from a variety of sources. In 4 addition to being widely scattered, much of the accumulated wisdom about 5 construction has reside outside written sources for years (Hildebrand 1989, 6 McConnell 1997a). There is nothing mysterious about the effective, high- 7 powered programming techniques used by expert programmers. In the day-to- 8 day rush of grinding out the latest project, however, few experts take the time to
de Complete . Preface Page iii 9 share what they have learned. Consequently, programmers may have difficulty 0 finding a good source of programming information. 1 The techniques described in this book fill the void after introductory and 2 advanced programming texts. After you have read Introduction to Java, 3 Advanced Java, and Advanced Advanced Java, what book do you read to learn 4 more about programming? You could read books about the details of Intel or 5 Motorola hardware, Windows or Linux operating-system functions, or about the 6 details of another programming language—you can’t use a language or program 7 in an environment without a good reference to such details. But this is one of the 8 few books that discusses programming per se. Some of the most beneficial 9 programming aids are practices that you can use regardless of the environment or 0 language you’re working in. Other books generally neglect such practices, which 1 is why this book concentrates on them. Other Professional software experience books Construction Magazine Programming articles language books Technology references 2 3 F00xx01 4 Figure 1 5 The information in this book is distilled from many sources. 6 The only other way to obtain the information you’ll find in this handbook would 7 be to plow through a mountain of books and a few hundred technical journals 8 and then add a significant amount of real-world experience. If you’ve already 9 done all that, you can still benefit from this book’s collecting the information in 0 one place for easy reference. 1 Key Benefits of This Handbook 2 Whatever your background, this handbook can help you write better programs in 3 less time and with fewer headaches.
de Complete . Preface Page iv 4 Complete software-construction reference 5 This handbook discusses general aspects of construction such as software quality 6 and ways to think about programming. It gets into nitty-gritty construction 7 details such as steps in building classes, ins and outs of using data and control 8 structures, debugging, refactoring, and code-tuning techniques and strategies. 9 You don’t need to read it cover to cover to learn about these topics. The book is 0 designed to make it easy to find the specific information that interests you. 1 Ready-to-use checklists 2 This book includes checklists you can use to assess your software architecture, 3 design approach, class and routine quality, variable names, control structures, 4 layout, test cases, and much more. 5 State-of-the-art information 6 This handbook describes some of the most up-to-date techniques available, many 7 of which have not yet made it into common use. Because this book draws from 8 both practice and research, the techniques it describes will remain useful for 9 years. 0 Larger perspective on software development 1 This book will give you a chance to rise above the fray of day-to-day fire 2 fighting and figure out what works and what doesn’t. Few practicing 3 programmers have the time to read through the dozens of software-engineering 4 books and the hundreds of journal articles that have been distilled into this 5 handbook. The research and real-world experience gathered into this handbook 6 will inform and stimulate your thinking about your projects, enabling you to take 7 strategic action so that you don’t have to fight the same battles again and again. 8 Absence of hype 9 Some software books contain 1 gram of insight swathed in 10 grams of hype. 0 This book presents balanced discussions of each technique’s strengths and 1 weaknesses. You know the demands of your particular project better than anyone 2 else. This book provides the objective information you need to make good 3 decisions about your specific circumstances. 4 Concepts applicable to most common languages 5 This book describes techniques you can use to get the most out of whatever 6 language you’re using, whether it’s C++, C#, Java, Visual Basic, or other similar 7 languages. 8 Numerous code examples 9 The book contains almost 500 examples of good and bad code. I’ve included so 0 many examples because, personally, I learn best from examples. I think other 1 programmers learn best that way too.
de Complete . Preface Page v 2 The examples are in multiple languages because mastering more than one 3 language is often a watershed in the career of a professional programmer. Once a 4 programmer realizes that programming principles transcend the syntax of any 5 specific language, the doors swing open to knowledge that truly makes a 6 difference in quality and productivity. 7 In order to make the multiple-language burden as light as possible, I’ve avoided 8 esoteric language features except where they’re specifically discussed. You don’t 9 need to understand every nuance of the code fragments to understand the points 0 they’re making. If you focus on the point being illustrated, you’ll find that you 1 can read the code regardless of the language. I’ve tried to make your job even 2 easier by annotating the significant parts of the examples. 3 Access to other sources of information 4 This book collects much of the available information on software construction, 5 but it’s hardly the last word. Throughout the chapters, “Additional Resources” 6 sections describe other books and articles you can read as you pursue the topics 7 you find most interesting. 8 Why This Handbook Was Written 9 The need for development handbooks that capture knowledge about effective 0 development practices is well recognized in the software-engineering 1 community. A report of the Computer Science and Technology Board stated that 2 the biggest gains in software-development quality and productivity will come 3 from codifying, unifying, and distributing existing knowledge about effective 4 software-development practices (CSTB 1990, McConnell 1997a). The board 5 concluded that the strategy for spreading that knowledge should be built on the 6 concept of software-engineering handbooks. 7 The history of computer programming provides more insight into the particular 8 need for a handbook on software construction. 9 The Topic of Construction Has Been Neglected 0 At one time, software development and coding were thought to be one and the 1 same. But as distinct activities in the software-development life cycle have been 2 identified, some of the best minds in the field have spent their time analyzing 3 and debating methods of project management, requirements, design, and testing. 4 The rush to study these newly identified areas has left code construction as the 5 ignorant cousin of software development.
de Complete . Preface Page vi 6 Discussions about construction have also been hobbled by the suggestion that 7 treating construction as a distinct software development activity implies that 8 construction must also be treated as a distinct phase. In reality, software 9 activities and phases don’t have to be set up in any particular relationship to each 0 other, and it’s useful to discuss the activity of construction regardless of whether 1 other software activities are performed in phases, in iterations, or in some other 2 way. 3 Construction Is Important 4 Another reason construction has been neglected by researchers and writers is the 5 mistaken idea that, compared to other software-development activities, 6 construction is a relatively mechanical process that presents little opportunity for 7 improvement. Nothing could be further from the truth. 8 Construction typically makes up about 80 percent of the effort on small projects 9 and 50 percent on medium projects. Construction accounts for about 75 percent 0 of the errors on small projects and 50 to 75 percent on medium and large 1 projects. Any activity that accounts for 50 to 75 percent of the errors presents a 2 clear opportunity for improvement. (Chapter 27 contains more details on this 3 topic.) 4 Some commentators have pointed out that although construction errors account 5 for a high percentage of total errors, construction errors tend to be less expensive 6 to fix than those caused by requirements and architecture, the suggestion being 7 that they are therefore less important. The claim that construction errors cost less 8 to fix is true but misleading because the cost of not fixing them can be incredibly 9 high. Researchers have found that small-scale coding errors account for some of 0 the most expensive software errors of all time with costs running into hundreds 1 of millions of dollars (Weinberg 1983, SEN 1990). 2 Small-scale coding errors might be less expensive to fix than errors in 3 requirements or architecture, but an inexpensive cost to fix obviously does not 4 imply that fixing them should be a low priority. 5 The irony of the shift in focus away from construction is that construction is the 6 only activity that’s guaranteed to be done. Requirements can be assumed rather 7 than developed; architecture can be shortchanged rather than designed; and 8 testing can be abbreviated or skipped rather than fully planned and executed. But 9 if there’s going to be a program, there has to be construction, and that makes 0 construction a uniquely fruitful area in which to improve development practices.
de Complete . Preface Page vii 1 No Comparable Book Is Available 2 When art critics get In light of construction’s obvious importance, I was sure when I conceived this 3 together they talk about book that someone else would already have written a book on effective 4 Form and Structure and construction practices. The need for a book about how to program effectively 5 Meaning. When artists seemed obvious. But I found that only a few books had been written about 6 get together they talk construction and then only on parts of the topic. Some had been written 15 years 7 about where you can buy ago or more and employed relatively esoteric languages such as ALGOL, PL/I, 8 cheap turpentine. Ratfor, and Smalltalk. Some were written by professors who were not working 9 —Pablo Picasso on production code. The professors wrote about techniques that worked for 0 student projects, but they often had little idea of how the techniques would play 1 out in full-scale development environments. Still other books trumpeted the 2 authors’ newest favorite methodologies but ignored the huge repository of 3 mature practices that have proven their effectiveness over time. 4 In short, I couldn’t find any book that had even attempted to capture the body of 5 practical techniques available from professional experience, industry research, 6 and academic work. The discussion needed to be brought up to date for current 7 programming languages, object-oriented programming, and leading-edge 8 development practices. It seemed clear that a book about programming needed to 9 be written by someone who was knowledgeable about the theoretical state of the 0 art but who was also building enough production code to appreciate the state of 1 the practice. I conceived this book as a full discussion of code construction— 2 from one programmer to another. 3 Book Website 4 CC2E.COM/ 1234 Updated checklists, recommended reading, web links, and other content are 5 provided on a companion website at www.cc2e.com. To access information 6 related to Code Complete, 2d Ed., enter cc2e.com/ followed by the four-digit 7 code, as shown in the left margin and throughout the book. 8 Author Note 9 If you have any comments, please feel free to contact me care of Microsoft 0 Press, on the Internet as stevemcc@construx.com, or at my Web site at 1 www.stevemcconnell.com. 2 Bellevue, Washington 3 New Year’s Day, 2004
de Complete 1. Welcome to Software Construction Page 1 1 1 2 Welcome to Software 3 Construction 4 CC2E.COM/ 0178 Contents 5 1.1 What Is Software Construction? 6 1.2 Why Is Software Construction Important? 7 1.3 How to Read This Book 8 Related Topics 9 Who should read the book: Preface 0 Benefits of reading the book: Preface 1 Why the book was written: Preface 2 You know what “construction” means when it’s used outside software 3 development. “Construction” is the work “construction workers” do when they 4 build a house, a school, or a skyscraper. When you were younger, you built 5 things out of “construction paper.” In common usage, “construction” refers to 6 the process of building. The construction process might include some aspects of 7 planning, designing, and checking your work, but mostly “construction” refers to 8 the hands-on part of creating something. 9 1.1 What Is Software Construction? 0 Developing computer software can be a complicated process, and in the last 25 1 years, researchers have identified numerous distinct activities that go into 2 software development. They include 3 ● Problem definition 4 ● Requirements development 5 ● Construction planning 6 ● Software architecture, or high-level design
de Complete 1. Welcome to Software Construction Page 2 7 ● Detailed design 8 ● Coding and debugging 9 ● Unit testing 0 ● Integration testing 1 ● Integration 2 ● System testing 3 ● Corrective maintenance 4 If you’ve worked on informal projects, you might think that this list represents a 5 lot of red tape. If you’ve worked on projects that are too formal, you know that 6 this list represents a lot of red tape! It’s hard to strike a balance between too little 7 and too much formality, and that’s discussed in a later chapter. 8 If you’ve taught yourself to program or worked mainly on informal projects, you 9 might not have made distinctions among the many activities that go into creating 0 a software product. Mentally, you might have grouped all of these activities 1 together as “programming.” If you work on informal projects, the main activity 2 you think of when you think about creating software is probably the activity the 3 researchers refer to as “construction.” 4 This intuitive notion of “construction” is fairly accurate, but it suffers from a 5 lack of perspective. Putting construction in its context with other activities helps 6 keep the focus on the right tasks during construction and appropriately 7 emphasizes important nonconstruction activities. Figure 1-1 illustrates 8 construction’s place related to other software development activities.