Home > Articles > Programming > Windows Programming

.NET Patterns, Part I

As you develop for .NET, you'll notice that the framework classes that you use adhere to standard naming conventions and programming patterns. You can apply these conventions and patterns in any .NET language. If they're emulated in your class libraries, they will allow other developers to use and extend your classes more efficiently. Dan Fox explores the topic of class library design in greater detail.
Like this article? We recommend

Now that Visual Studio .NET (VS .NET) and the .NET Framework have been released, development using the new tools and technology can proceed in earnest. However, as developers begin to build new solutions and rework existing code to take advantage of XML Web Services, ADO.NET, and other features of .NET, it's good to revisit some fundamentals concepts that will make development in .NET more efficient. In particular, adhering to the design guidelines covered in these two articles will make it easier to maintain and extend your .NET applications by using common naming conventions, usage, and design patterns.

As you develop for .NET, you'll notice that the framework classes that you'll work with—for example, the class of the System.Xml, System.Data, and System.IO namespaces, adhere to standard naming conventions and programming patterns. These conventions and patterns can be applied in any .NET language and, if emulated in your class libraries, will allow other developers to use and extend your classes more efficiently. The basis for the guidelines discussed in these two articles can be found in the online documentation that ships with VS .NET. By opening the documentation and searching for "class library design guidelines" in the index, you'll be presented with a wealth of topics, the most important of which we'll explore in this article.

Naming Conventions

You'll probably notice right away when working with VS .NET that the capitalization conventions for classes, variables, data types, arguments, and so forth are slightly different than those you might have used in VB 6.0 or VBScript. In fact, the framework uses three different styles of capitalization: Pascal case, camel case, and upper case. Pascal case is the most prevalent; it refers to identifiers with no spaces and with each individual word capitalized. In .NET, Pascal case should be used to identify classes, enumerated types, events, public fields, interfaces, methods, namespaces, and properties. For example, the declaration of a class in VB .NET would use Pascal case as follows.

Public Class QuilogyException : Inherits ApplicationException

The second most prevalent convention is the use of camel case. Camel case refers to identifiers in which the first word in the identifier is left in lower case while subsequent words are capitalized. In the framework, camel case is used for parameters and protected fields—for example, a constructor of the QuilogyException class would be defined as follows:

Public Sub New(ByVal message as String, 
ByVal innerException as Exception)

Notice that the parameters use camel casing while the names of the method and the types use Pascal casing. Upper case is reserved only for identifiers that consist of two or fewer letters. As a result, you'll typically see upper case used for namespaces such as System.IO and System.Web.UI. Keep in mind as well that different languages handle capitalization differently, so you do not want to create code that requires case sensitivity. In other words, if you were writing a class in C#, you would not create both ReadXml and readXml methods: VB .NET is not case sensitive, so VB .NET clients would not be able to differentiate between the two.

In VB and VBScript, parameters and variables often are prefixed with a two- or three-letter prefix that denoted the data type, perhaps along with a prefix that denote the scope—for example, str for strings and int for integers, prefixed with m for the module's level or l for local. This Hungarian notation was informative but resulted in long variable and parameter names. As shown in the previous snippet, Hungarian notation is no longer used in .NET where the identifier should be in camel case and simply describes the meaning of the variable or parameter. The only prefix that you'll typically see is an underscore to denote that a field or method is private to a class. The reasons for abandoning Hungarian notation include the fact that VS .NET already provides copious type information through the object browser, ToolTips, and the Watch window, as well as for the previously mentioned reason that you don't want to create variable and parameter names that include any language-specific information.

As mentioned previously, namespaces should use Pascal casing. Namespaces come in handy when you're designing classes that will be reusable and want to group them into a hierarchical structure that makes them easier to work with. For example, you might want to organize all of the classes in your organization that represent and access data in a hierarchical namespace structure. The general convention is that the top-level namespace in the hierarchy should be your organization name, with as many nested namespaces as necessary to fully represent your hierarchy. For example, Quilogy might group all of its data access classes, interfaces, and enumerated types into a Quilogy.Data namespace that contains nested namespaces for each core area of the company, including Quilogy.Data.Consulting, Quilogy.Data.Education and Quilogy.Data.Hosting. In a structure such as this, the classes and interfaces in the lower-level namespaces should have a dependency on those in the next highest level; classes in the Quilogy.Data.Consulting namespace might inherit from classes and interfaces in the Quilogy.Data namespace.

Finally, you should use consistent naming rules when naming your classes and interfaces. In the previous example of the QuilogyException class, the class name is a noun or noun phrase, uses Pascal casing, and is not prefixed with a C, as you sometimes see particularly in previous versions of VB. In addition, class names should not use underscores and should avoid abbreviations where possible. In this case, the class name also contains a piece of its base class name to identify that QuilogyException is a type of Exception. Although this is not a hard-and-fast rule, it can be useful in helping developers using your class get an immediate feel for how your class might behave.

Interfaces follow many of the same rules, including the prohibition on underscores and abbreviations and the use of Pascal casing. However, interfaces should be prefixed with an I and can be named using an adjective phrase that describes the functionality exposed by the interface instead of using a descriptive noun or noun phrase. For example, the framework contains the ICloneable interface that is implemented by a whole host of classes such as String, Stack, Array, SortedList, and Delegate, among others. Here, cloneable is an adjective that describes the functionality that the class gains by implementing the interface. Class and interface names also should differ only by the I prefix when the class is the standard implementation of the interface. For example, the QuilogyDataAccess class might provide the standard implementation of the IQuilogyDataAccess interface, as shown here:

Interface IQuilogyDataAccess
 Function GetById(ByVal id As Integer) As DataSet
 Function Save(ByVal ds As DataSet) As Boolean
End Interface

Public Class QuilogyDataAccess : Inherits IQuilogyDataAccess
 Public Function GetByPk(ByVal id As Integer) As _
  DataSet Implements IQuilogyDataAccess.GetById
  ' implementation
 End Function

 Public Function Save(ByVal ds As DataSet) As _
  Boolean Implements IQuilogyDataAccess.Save
  ' implementation
 End Function
End Class

One of the interesting differences between VB .NET and C# is in the syntax used to identify the methods that map to the interface that is implemented (inherited in C#). In the previous example, the VB .NET code uses the Implements keyword on each method to identify which member of the interface the method maps to. This allows the method name exposed to the outside world to be different from the interface method name. In other words, the GetByPk method in QuilogyDataAccess can be mapped to the GetById method of Interface. When referencing the class, I can call the method simply using GetByPk; when referencing the interface, I can use GetById. As a result, the following code snippet ends up calling the same method twice:

Dim o As New QuilogyDataAcess()
Dim d As IQuilogyDataAccess

d = o
o.GetByPk(3)
d.GetById(3)

However, C# does not allow you to implement the members of an interface in your class using alternate names. Still, you can explicitly place the name of the interface in the method name, as shown below:

public class QuilogyDataAccess : IQuilogyDataAccess
{
 DataSet IQuilogyDataAccess.GetById(int id)
 {
   //implementation
 }
 
 public Boolean Save(DataSet ds)
 {
   //implementation
 }
}

In this case, the GetById method is implemented using the name of the interface, whereas the Save method is not. Doing so exposes the GetById method only through the interface, whereas the Save method can be called both through the reference to the class and through the interface, as exemplified in the following snippet:

QuilogyDataAccess o = new QuilogyDataAccess();

o.Save(ds); //legal
o.GetById(3); //illegal

((IQuilogyDataAccess)d).GetById(3); //legal
((IQuilogyDataAccess)d).Save(ds); //legal

This is particularly handy when your class implements two interfaces that expose a member of the same name. However, when you define the method using the explicit name from the interface, access modifiers such as public, protected, and internal are not allowed and the method cannot be marked as virtual.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020