560-2 fm.qxd 10/27/05 4:30 PM Page i Pro NET 2.0 Code and Design Standards in C# Mark Horner 560-2 fm.qxd 10/27/05 4:30 PM Page ii Pro NET 2.0 Code and Design Standards in C# Copyright © 2006 by Torville Pty Ltd All rights reserved No part of this work may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage or retrieval system, without the prior written permission of the copyright owner and the publisher ISBN (pbk): 1-59059-560-2 Printed and bound in the United States of America Trademarked names may appear in this book Rather than use a trademark symbol with every occurrence of a trademarked name, we use the names only in an editorial fashion and to the benefit of the trademark owner, with no intention of infringement of the trademark Lead Editor: Ewan Buckingham Technical Reviewer: Jon Reid Editorial Board: Steve Anglin, Dan Appleman, Ewan Buckingham, Gary Cornell, Tony Davis, Jason Gilmore, Jonathan Hassell, Chris Mills, Dominic Shakeshaft, Jim Sumser Associate Publisher: Grace Wong Project Manager: Beckie Brand Copy Edit Manager: Nicole LeClerc Copy Editors: Freelance Editorial Services and Ami Knox Assistant Production Director: Kari Brooks-Copony Production Editor: Ellie Fountain Compositor: Molly Sharp Proofreader: Linda Seifert Indexer: Toma Mulligan Artist: Kinetic Publishing Services, LLC Interior Designer: Van Winkle Design Group Cover Designer: Kurt Krames Manufacturing Director: Tom Debolski Distributed to the book trade worldwide by Springer-Verlag New York, Inc., 233 Spring Street, 6th Floor, New York, NY 10013 Phone 1-800-SPRINGER, fax 201-348-4505, e-mail orders-ny@springer-sbm.com, or visit http://www.springeronline.com For information on translations, please contact Apress directly at 2560 Ninth Street, Suite 219, Berkeley, CA 94710 Phone 510-549-5930, fax 510-549-5939, e-mail info@apress.com, or visit http://www.apress.com The information in this book is distributed on an “as is” basis, without warranty Although every precaution has been taken in the preparation of this work, neither the author(s) nor Apress shall have any liability to any person or entity with respect to any loss or damage caused or alleged to be caused directly or indirectly by the information contained in this work The source code for this book is available to readers at http://www.apress.com in the Source Code section 560-2 fm.qxd 10/27/05 4:30 PM Page iii Contents at a Glance About the Author xiii About the Technical Reviewer xv Acknowledgments xvii Introduction xix PART ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER PART ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER PART ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER PART ■■■ Code Policy Code Structure 29 Code Development 39 Code Documentation 85 ■■■ Design Policy Standards Design Policy 103 Design Structure 119 Design Development 141 Design Documentation 159 ■■■ 10 11 12 Code Policy Standards Pattern Standards Patterns 171 Creational Patterns 183 Structural Patterns 203 Behavioral Patterns 235 ■■■ References ■APPENDIX A Environment Variables and Remote Proxy Example 257 ■LIST OF STANDARDS 269 ■GLOSSARY 287 ■INDEX 319 iii 560-2 fm.qxd 10/27/05 4:30 PM Page iv 560-2 Index.qxd 10/27/05 4:22 PM Page 335 BOB_Forums7x925 8/18/03 Page 336 forums.apress.com FOR PROFESSIONALS BY PROFESSIONALS™ JOIN THE APRESS FORUMS AND BE PART OF OUR COMMUNITY You’ll find discussions that cover topics of interest to IT professionals, programmers, and enthusiasts just like you If you post a query to one of our forums, you can expect that some of the best minds in the business—especially Apress authors, who all write with The Expert’s Voice™—will chime in to help you Why not aim to become one of our most valuable participants (MVPs) and win cool stuff? Here’s a sampling of what you’ll find: DATABASES PROGRAMMING/BUSINESS Data drives everything Share information, exchange ideas, and discuss any database programming or administration issues Unfortunately, it is Talk about the Apress line of books that cover software methodology, best practices, and how programmers interact with the “suits.” INTERNET TECHNOLOGIES AND NETWORKING WEB DEVELOPMENT/DESIGN Try living without plumbing (and eventually IPv6) Talk about networking topics including protocols, design, administration, wireless, wired, storage, backup, certifications, trends, and new technologies Ugly doesn’t cut it anymore, and CGI is absurd Help is in sight for your site Find design solutions for your projects and get ideas for building an interactive Web site JAVA SECURITY We’ve come a long way from the old Oak tree Hang out and discuss Java in whatever flavor you choose: J2SE, J2EE, J2ME, Jakarta, and so on Lots of bad guys out there—the good guys need help Discuss computer and network security issues here Just don’t let anyone else know the answers! MAC OS X TECHNOLOGY IN ACTION All about the Zen of OS X OS X is both the present and the future for Mac apps Make suggestions, offer up ideas, or boast about your new hardware Cool things Fun things It’s after hours It’s time to play Whether you’re into LEGO® MINDSTORMS™ or turning an old PC into a DVR, this is where technology turns into fun OPEN SOURCE WINDOWS Source code is good; understanding (open) source is better Discuss open source technologies and related topics such as PHP, MySQL, Linux, Perl, Apache, Python, and more No defenestration here Ask questions about all aspects of Windows programming, get help on Microsoft technologies covered in Apress books, or provide feedback on any Apress Windows book HOW TO PARTICIPATE: Go to the Apress Forums site at http://forums.apress.com/ Click the New User link ...5 60 -2 fm.qxd 10 /27 /05 4: 30 PM Page i Pro NET 2. 0 Code and Design Standards in C# Mark Horner 5 60 -2 fm.qxd 10 /27 /05 4: 30 PM Page ii Pro NET 2. 0 Code and Design Standards in C# Copyright © 20 06... Brooks-Copony Production Editor: Ellie Fountain Compositor: Molly Sharp Proofreader: Linda Seifert Indexer: Toma Mulligan Artist: Kinetic Publishing Services, LLC Interior Designer: Van Winkle Design. .. to be caused directly or indirectly by the information contained in this work The source code for this book is available to readers at http://www.apress.com in the Source Code section 5 60 -2 fm.qxd