Identifier
| Case
| Example
|
Class
| Pascal
| Application
|
Enum
| Pascal
| ErrorLevel
|
Enum value
| Pascal
| FatalError
|
Event
| Pascal
| ValueChange
|
Exception class
| Pascal
| WebException (always ends with Exception)
|
Attribute class
| Pascal
| VersionAttribute (always ends with Attribute)
|
Interface
| Pascal
| IDisposable (always starts with I)
|
Method
| Pascal
| ToString
|
Namespace
| Pascal
| System
|
Parameter
| Camel
| typeName
|
Property
| Pascal
| BackColor
|
Private field
| Camel
| redValue
|
Non-private field
| Pascal
| RedValue
|
Local variable
| Camel
| accountType
|
Type parameter
| Pascal
| TSession
|
Comments
Introduction
All source code documenting inside source files has to follow C# language specification (“Documentation comments” appendix). Specific additions are described in the following sub-sections.
Class comments
Although it’s recommended to provide enough details on each source code part (method, class, etc) in accordance with C# language specification, at least class <summary> section is absolutely mandatory. No file should be delivered without this part of source code documentation.