打造可维护的C#软件：未来-proof代码的10条准则

需积分: 0 134 浏览量更新于2024-07-20 收藏 16.71MB PDF 举报

"Building Maintainable Software, C# Edition" 是一本由 Software Improvement Group (SIG) 的咨询师 Joost Visser 编写的书籍，出版于 O'Reilly 在2016年。这本书专注于解决软件开发中的一大问题——难以维护的源代码，导致项目延期和缺陷。书中提出了10个简单易行的指导原则，旨在帮助开发者编写易于维护和适应变化的C#软件。通过分析大量真实世界的系统，作者提炼出了这些原则，并提供了清晰、简洁的解释和实践建议。本书以C#语言为例，同时有一个对应的Java版书籍，用该语言展示了相关的示例。主要内容摘录中提到了书的作者Joost Visser以及书名《Building Maintainable Software》的C#版本，强调了书中的10条原则是为构建未来的、可扩展的代码服务的。O'Reilly Media作为出版商，确保了书籍的广泛分布，同时也提供了一些在线版本供读者选择。从标签"Building Maintainable Software C#"可以看出，这本书的核心是关于如何构建可维护的C#软件。以下是这10个指导原则的详细解读： 1. **明确性**：代码应清晰易懂，避免隐晦的表达和复杂的逻辑，使其他开发者能快速理解其功能和意图。 2. **一致性**：保持代码风格、命名约定和设计模式的一致性，以便于团队合作和代码审查。 3. **模块化**：通过分解代码为小而独立的模块，提高可读性和测试性，减少组件间的耦合。 4. **低复杂度**：尽量降低函数、类和模块的复杂度，使代码更易于理解和维护。 5. **错误处理**：合理的错误处理策略，如异常处理和日志记录，有助于快速定位和解决问题。 6. **可测试性**：编写可测试的代码，包括使用单元测试和集成测试来验证功能。 7. **文档**：提供必要的注释和文档，帮助理解代码的意图和使用方式，但避免过度文档化。 8. **可配置性**：允许通过配置文件或参数调整行为，以适应不同的环境和需求。 9. **可扩展性**：设计代码以支持未来的功能添加或修改，避免过早优化，但也要考虑性能。 10. **可维护性**：持续关注和改进代码质量，使用工具进行静态分析，及时修复潜在问题。通过遵循这些原则，开发者可以创建出更易于团队协作、适应变更、减少维护成本的C#软件项目。这本书是任何希望提升代码质量、提升团队效率的C#开发者的重要参考资料。

About This Edition

This is the C# edition of the book. All code examples are in C# (and in C# only), and

the text frequently refers to tools and terms that are widely used in the C# commu‐

nity, but not necessarily outside of it. We assume that the reader has experience in C#

programming. As previously noted, the guidelines, while presented in this edition in

C#, are independent of the programming language used. A Java edition is published

concurrently by O’Reilly.

Related Books

We present 10 basic guidelines for achieving high maintainability. While it might be

the first book many people will read on the topic of maintainability, we hope it will

certainly not be the last one. We recommend several books as follow-up:

Building

Soware Teams, by the Soware Improvement Group

This is the companion to the current book, written by the same authors. While

the current book focuses on developer guidelines for building maintainable soft‐

ware, this book focuses on development process best practices and how to meas‐

ure them wisely with the Goal-Question-Metric approach. Building

Soware

Teams is scheduled for publication in 2016.

Refactoring: Improving the Design of Existing Code, by Martin Fowler

This book focuses on improving maintainability (and other quality characteris‐

tics) of existing code.

Clean Code: A Handbook of Agile

Soware Crasmanship, by Robert C. Martin (a.k.a.

Uncle Bob)

Like the current book, Clean Code is about building software source code that is

of high quality. Clean Code describes guidelines at a higher level of abstraction.

Code Quality:

e Open Source Perspective, by Diomidis Spinellis

Also like the current book, Code Quality presents guidelines for code quality, but

like Clean Code, they are presented at a higher level of abstraction.

Design Patterns: Elements of Reusable Object-Oriented

Soware, by Erich Gamma,

Richard Helm, Ralph Johnson, and John Vlissides (a.k.a. the Gang of Four)

This is recommended reading for those software developers who want to become

better software architects.

xiv | Preface

www.it-ebooks.info

readonly for exactly the same thing. As another example, C# provides a feature called

partial classes, which Java (currently) does not provide.

In addition to differences in syntax, programming languages also differ in the termi‐

nology they use in textbooks, tutorials, and their individual specifications. For

instance, the concept of a group of code lines that can be executed as a whole is

known in almost every programming language. In Java and C#, this concept is called

a method. In Visual Basic, it is called a subroutine. In JavaScript and C, it is known as a

function. In Pascal, it is known as a procedure.

That is why a technology-independent model needs generic names for grouping con‐

cepts. Table P-1 presents the generic names that we use throughout the chapters.

Table P-1. A generic grouping of concepts and their representation in C#.

Generic name Generic denition In C#

Unit Smallest grouping of lines that can be executed independently Method or constructor

Module Smallest grouping of units Top-level class, interface, or enum

Component Top-level division of a system as dened by its software architecture (Not dened by the language)

System The entire codebase under study (Not dened by the language)

The following list further clarifies the relationship between the grouping constructs

described in Table P-1 and the practice of C# programming:

From smallest to largest

The grouping concepts in Table P-1 are ordered from smallest to largest. A unit

itself consists of statements, but statements are not a grouping construct.

In C#, as in many other programming languages, there is a com‐

plex relationship between statements and lines in the .cs file in

which they appear. A line may have more than one statement, but a

statement can be spread over multiple lines. We simply look at lines

of code (LoC): any line in source code that ends with an Enter/

Return, and neither is empty nor contains only a comment.

Some concepts are not

dened in a particular language

As Table P-1 shows, some generic concepts are not represented in C#. For

instance, in C# there is no syntax to describe the boundaries of a system. This

concept is introduced in the generic terminology because we do need it. It is not

a problem that C# lacks the syntax: in practice we have other ways to determine

these boundaries.

xvi | Preface

www.it-ebooks.info

Some well-known generic concepts play no role

You might be surprised that Table P-1 does not define well-known terms such as

subcomponent and subsystem. The reason is simple: we do not need them for the

guidelines.

Not all grouping constructs of a language are represented

C# has more grouping constructs than those listed in Table P-1. C# has namespa‐

ces to group classes and interfaces. C# also has nested classes. They are not listed

in Table P-1 because we do not need them for the guidelines. For example, we do

not need to distinguish between classes and nested classes to formulate our

guidelines about coupling.

A C# namespace is not the same as a component in the generic ter‐

minology. In very small C# systems, there may be a one-to-one

mapping between components and namespaces. In larger C# sys‐

tems, there are usually far more namespaces than components.

Build tooling plays no role in the generic terminology

In C# development, Visual Studio provides an additional grouping concept: build

targets. However, build targets play no role in the guidelines. There may be a

one-to-one relation between on the one hand components and on the other hand

build targets, but this is not a rule.

Components are determined by the architecture of the system

A component is not a C# concept. Components are neither namespaces nor Vis‐

ual Studio build targets or solutions. In a given system, there may be a one-to-

one mapping between components and Visual Studio projects of solutions, but

that is not a rule. Instead, components are the highest-level building blocks as

identified by the software architecture of the system. They are the blocks in a

“blocks-and-arrows” diagram of the system. Chapter 7 further explains the con‐

cept of components and presents some examples.

Using Code Examples

Supplemental material (code examples, exercises, etc.) is available for download at

https://github.com/oreillymedia/building_maintainable_soware.

This book is here to help you get your job done. In general, if example code is offered

with this book, you may use it in your programs and documentation. You do not

need to contact us for permission unless you’re reproducing a significant portion of

the code. For example, writing a program that uses several chunks of code from this

book does not require permission. Selling or distributing storage media (e.g., CD-

ROM) of examples from O’Reilly books does require permission. Answering a

Preface | xvii

www.it-ebooks.info

question by citing this book and quoting example code does not require permission.

Incorporating a significant amount of example code from this book into your pro‐

duct’s documentation does require permission.

We appreciate, but do not require, attribution. An attribution usually includes the

title, authors, publisher, and ISBN. For example: “Building Maintainable

Soware, C#

978-1-4919-5452-2.”

If you feel your use of code examples falls outside fair use or the permission given

above, you may contact us at permissions@oreilly.com for special permission.

Safari® Books Online

Safari Books Online is an on-demand digital library that deliv‐

ers expert content in both book and video form from the

world’s leading authors in technology and business.

Technology professionals, software developers, web designers, and business and crea‐

tive professionals use Safari Books Online as their primary resource for research,

problem solving, learning, and certification training.

Safari Books Online offers a range of plans and pricing for enterprise, government,

education, and individuals.

Members have access to thousands of books, training videos, and prepublication

manuscripts in one fully searchable database from publishers like O’Reilly Media,

Prentice Hall Professional, Addison-Wesley Professional, Microsoft Press, Sams, Que,

Peachpit Press, Focal Press, Cisco Press, John Wiley & Sons, Syngress, Morgan Kauf‐

mann, IBM Redbooks, Packt, Adobe Press, FT Press, Apress, Manning, New Riders,

McGraw-Hill, Jones & Bartlett, Course Technology, and hundreds more. For more

information about Safari Books Online, please visit us online.

How to Contact Us

Please address comments and questions concerning this book to the publisher:

O’Reilly Media, Inc.

1005 Gravenstein Highway North

Sebastopol, CA 95472

800-998-9938 (in the United States or Canada)

707-829-0515 (international or local)

707-829-0104 (fax)

xviii | Preface

www.it-ebooks.info

剩余171页未读，继续阅读

vanridin

粉丝: 108
资源: 1188

打造可维护的C#软件：未来-proof代码的10条准则

Building Maintainable Software, C# Edition [2016]

Building Maintainable Software C# Edition epub

关于java的外语文献_java英文参考文献（涵盖3年最新120个）

spring-boot

用英语并使用sci期刊的语言风格来说Vue.js的概念和作用

lit-element slim-js

Test-Driven Development

给我找两篇英文文献有关于Java或者springboot框架或者vue的

ASP.NET MVC

Blazor Services

最新资源