-
Notifications
You must be signed in to change notification settings - Fork 9
Code style
Unless specified otherwise, always follow the C# Coding Conventions defined by Microsoft.
This is a list of general rules to follow when writing code for this project. When in doubt, look at similar classes in the project and try to follow the same structure. Otherwise, just ask for guidance :) There might be additions to these rules as the project progresses.
Always use names that clearly indicate what your class/method/variable is supposed to represent.
Use PascalCase when naming methods, public fields and properties.
Private methods should still follow the PascalCase, similarly to public members.
Private fields should use the camelCase, prefixed with an underscore, like this: private readonly DbContext _dbContext
.
Keep interface names generic and class names specific.
As an example, do not name your interface ITheNewBostonAPIWrapper
and a class TheNewBostonAPIWrapper
.
Instead, name them IAPIWrapper
and TheNewBostonAPIWrapper
.