Skip to content

Add Naming Conventions Table #182

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Feb 14, 2022
Merged

Add Naming Conventions Table #182

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f6a4af4
Create Naming Conventions Table
BenjaminMichaelis Jun 15, 2021
62f5692
Move table to new file
BenjaminMichaelis Jun 15, 2021
5bedad0
Update link to table in index
BenjaminMichaelis Jun 16, 2021
8275e6c
Update Table
BenjaminMichaelis Feb 4, 2022
db873c3
Fix table file name
BenjaminMichaelis Feb 4, 2022
aa0d3af
Minor Changes
BenjaminMichaelis Feb 5, 2022
f1f09a4
Minor Improvements
BenjaminMichaelis Feb 9, 2022
4c61910
Minor changes from code review
BenjaminMichaelis Feb 14, 2022
b969b9a
Minor changes
BenjaminMichaelis Feb 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions docs/assets/C#NamingGuidelinesTable.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# C# Naming Conventions - Quick Reference Table

| Kind | Naming Convention | Example |
| ------------------------------------ | ----------------- | ------------------------------------------------------------------ |
| Classes | PascalCase | `class Car` |
| Types and Namespaces | PascalCase | `namespace VehicleManufacturer;` |
| Parameters | camelCase | `public Car(int odometerMileage, string manufacturer)` |
| Methods | PascalCase | `public void StartEngine()` |
| Properties | PascalCase | `public double FuelLevel { get; set; }` |
| Local Variables | camelCase | `int yearManufactured;` |
| Local Functions | PascalCase | `string CalculateMilesUntilEmpty(double fuelLevel)` |
| Fields | _PascalCase | `private string _Day;` |
| Enum Members | PascalCase | `enum Status { Unknown, Operational, Broken, InShop }` |
| Type Parameters | TPascalCase | `public TOutput Convert<TInput, TOutput>(TInput from)` |
| Interfaces | IPascalCase | `interface ISampleInterface` |
3 changes: 0 additions & 3 deletions docs/coding/csharp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@
# Guidelines





## ***Coding***

### Arrays
Expand Down
1 change: 1 addition & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ title: IntelliTect Guidelines
Coding Guidelines
================
* [C#]({{ site.baseurl }}{% link coding/csharp.md %})
* [C# Naming Guidelines Table]({{ site.baseurl }}{% link assets/C#NamingGuidelinesTable.md %})
* [JavaScript]({{ site.baseurl }}{% link coding/javascript.md %})

Analyzers
Expand Down