1.2.12 Naming Conventions

Names Communicate the Role of Code

C# identifiers name:

• classes;
• fields;
• objects;
• later, methods and other members.

A good name helps a reader understand what the code represents.

Class Names Identify Types

Examples:

Player
Team
Match

Class names commonly use PascalCase in C#.

The name should describe the kind of object.

Field Names Identify Stored Information

Examples:

name
jerseyNumber
isAvailable
team

Use the naming convention required by the current course and StyleCop configuration.

Do not rename supplied identifiers simply because another convention appears online.

Names Should Be Specific Enough to Be Useful

Compare:

x
data
thing

with:

jerseyNumber
isAvailable
team

The second group communicates more meaning.

Preserve Traceability Across UML and Code

If UML shows:

jerseyNumber : int

and C# declares:

public int jerseyNumber;

the connection is easy to follow.

Unnecessary renaming weakens that traceability.

Avoid Encoding Future Design Ideas in Names

A beginner field name should describe the current concept.

Do not add words implying:

• a property;
• a collection;
• a service;
• a database;

unless the current design actually contains that concept.

Names should describe what exists now.