From f6a4af4dec826c5ba93fd1747df031da7bd61fc9 Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Tue, 15 Jun 2021 12:11:33 -0700 Subject: [PATCH 1/9] Create Naming Conventions Table --- docs/coding/csharp.md | 25 ++++++++++++++++++++++--- 1 file changed, 22 insertions(+), 3 deletions(-) diff --git a/docs/coding/csharp.md b/docs/coding/csharp.md index 552be52a..8090ff8d 100644 --- a/docs/coding/csharp.md +++ b/docs/coding/csharp.md @@ -35,9 +35,28 @@ # Guidelines - - - +## Naming conventions - quick reference table + +| Kind | Naming Convention | Examples | +|--------------------------------------|-------------------|--------------------| +| Types and namespaces | UpperCamelCase | | +| Interfaces | IUpperCamelCase | | +| Methods | UpperCamelCase | | +| Properties | UpperCamelCase | | +| Type Parameters | TUpperCamelCase | | +| Events | UpperCamelCase | | +| Local Variables | lowerCamelCase | | +| Local constants | lowerCamelCase | | +| Parameters | lowerCamelCase | | +| Private Instance fields | _lowerCamelCase | | +| Private Static field | _lowerCamelCase | | +| Public Constant field | UpperCamelCase | | +| Private Constant field | UpperCamelCase | | +| Public Static readonly fields | UpperCamelCase | | +| Private Static readonly fields | UpperCamelCase | | +| Public Fields (not recommended) | UpperCamelCase | | +| Enum members | UpperCamelCase | | +| Local functions | UpperCamelCase | | ## ***Coding*** From 62f5692c3a788c662db13eca91d3a72fd5f1e0f3 Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Tue, 15 Jun 2021 14:32:04 -0700 Subject: [PATCH 2/9] Move table to new file --- docs/assets/C#NamingGuildelinesTable.md | 22 ++++++++++++++++++++++ docs/coding/csharp.md | 22 ---------------------- 2 files changed, 22 insertions(+), 22 deletions(-) create mode 100644 docs/assets/C#NamingGuildelinesTable.md diff --git a/docs/assets/C#NamingGuildelinesTable.md b/docs/assets/C#NamingGuildelinesTable.md new file mode 100644 index 00000000..31890ac2 --- /dev/null +++ b/docs/assets/C#NamingGuildelinesTable.md @@ -0,0 +1,22 @@ +# C# Naming conventions - quick reference table + +| Kind | Naming Convention | Examples | +|--------------------------------------|-------------------|--------------------| +| Types and namespaces | UpperCamelCase | | +| Interfaces | IUpperCamelCase | | +| Methods | UpperCamelCase | | +| Properties | UpperCamelCase | | +| Type Parameters | TUpperCamelCase | | +| Events | UpperCamelCase | | +| Local Variables | lowerCamelCase | | +| Local constants | lowerCamelCase | | +| Parameters | lowerCamelCase | | +| Private Instance fields | _lowerCamelCase | | +| Private Static field | _lowerCamelCase | | +| Public Constant field | UpperCamelCase | | +| Private Constant field | UpperCamelCase | | +| Public Static readonly fields | UpperCamelCase | | +| Private Static readonly fields | UpperCamelCase | | +| Public Fields (not recommended) | UpperCamelCase | | +| Enum members | UpperCamelCase | | +| Local functions | UpperCamelCase | | diff --git a/docs/coding/csharp.md b/docs/coding/csharp.md index 8090ff8d..f8f0c984 100644 --- a/docs/coding/csharp.md +++ b/docs/coding/csharp.md @@ -35,28 +35,6 @@ # Guidelines -## Naming conventions - quick reference table - -| Kind | Naming Convention | Examples | -|--------------------------------------|-------------------|--------------------| -| Types and namespaces | UpperCamelCase | | -| Interfaces | IUpperCamelCase | | -| Methods | UpperCamelCase | | -| Properties | UpperCamelCase | | -| Type Parameters | TUpperCamelCase | | -| Events | UpperCamelCase | | -| Local Variables | lowerCamelCase | | -| Local constants | lowerCamelCase | | -| Parameters | lowerCamelCase | | -| Private Instance fields | _lowerCamelCase | | -| Private Static field | _lowerCamelCase | | -| Public Constant field | UpperCamelCase | | -| Private Constant field | UpperCamelCase | | -| Public Static readonly fields | UpperCamelCase | | -| Private Static readonly fields | UpperCamelCase | | -| Public Fields (not recommended) | UpperCamelCase | | -| Enum members | UpperCamelCase | | -| Local functions | UpperCamelCase | | ## ***Coding*** From 5bedad0e60edb7a66a0492802a444f15ed833964 Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Wed, 16 Jun 2021 10:17:56 -0700 Subject: [PATCH 3/9] Update link to table in index --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 09424929..edb5bc1c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 From 8275e6c2d6ece605608d40e0d609c5a9043e397d Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Fri, 4 Feb 2022 14:23:51 -0800 Subject: [PATCH 4/9] Update Table --- docs/assets/C#NamingGuildelinesTable.md | 35 ++++++++++++------------- 1 file changed, 17 insertions(+), 18 deletions(-) diff --git a/docs/assets/C#NamingGuildelinesTable.md b/docs/assets/C#NamingGuildelinesTable.md index 31890ac2..6284a22e 100644 --- a/docs/assets/C#NamingGuildelinesTable.md +++ b/docs/assets/C#NamingGuildelinesTable.md @@ -2,21 +2,20 @@ | Kind | Naming Convention | Examples | |--------------------------------------|-------------------|--------------------| -| Types and namespaces | UpperCamelCase | | -| Interfaces | IUpperCamelCase | | -| Methods | UpperCamelCase | | -| Properties | UpperCamelCase | | -| Type Parameters | TUpperCamelCase | | -| Events | UpperCamelCase | | -| Local Variables | lowerCamelCase | | -| Local constants | lowerCamelCase | | -| Parameters | lowerCamelCase | | -| Private Instance fields | _lowerCamelCase | | -| Private Static field | _lowerCamelCase | | -| Public Constant field | UpperCamelCase | | -| Private Constant field | UpperCamelCase | | -| Public Static readonly fields | UpperCamelCase | | -| Private Static readonly fields | UpperCamelCase | | -| Public Fields (not recommended) | UpperCamelCase | | -| Enum members | UpperCamelCase | | -| Local functions | UpperCamelCase | | +| Classes | PascalCase | `class Car{}` | +| Types and Namespaces | PascalCase | `namespace SampleNamespace{}` | +| Parameters | camelCase | `public Car(int odometerMileage, string manufacturer)` | +| Methods | PascalCase | `public void StartEngine()` | +| Properties | PascalCase | `public double FuelLevel { get; set; }` | +| Local Variables | camelCase | `public int yearManufactured;` | +| Local Functions | PascalCase | `private string CalculateMilesUntilEmpty(double fuelLevel)` | +| Private Instance Fields | _IPascalCase | | +| Private Static Field | _PascalCase | | +| Public Constant Field | _PascalCase | | +| Private Constant Field | _PascalCase | | +| Public Static Readonly Fields | _PascalCase | | +| Private Static Readonly Fields | _PascalCase | | +| Public Fields (not recommended) | _PascalCase | `public string Day;` | +| Enum Members | PascalCase | | +| Type Parameters | TPascalCase | `public delegate TOutput Converter(TInput from);` | +| Interfaces | IPascalCase | `interface ISampleInterface` | From db873c366896f108eee827ae21139610ed774eac Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Fri, 4 Feb 2022 14:24:08 -0800 Subject: [PATCH 5/9] Fix table file name --- .../{C#NamingGuildelinesTable.md => C#NamingGuidelinesTable.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/assets/{C#NamingGuildelinesTable.md => C#NamingGuidelinesTable.md} (100%) diff --git a/docs/assets/C#NamingGuildelinesTable.md b/docs/assets/C#NamingGuidelinesTable.md similarity index 100% rename from docs/assets/C#NamingGuildelinesTable.md rename to docs/assets/C#NamingGuidelinesTable.md From aa0d3af4ec16fac4d32e95e871d3cdfac2642eeb Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Fri, 4 Feb 2022 23:35:29 -0800 Subject: [PATCH 6/9] Minor Changes Minor changes --- docs/assets/C#NamingGuidelinesTable.md | 39 +++++++++++++------------- 1 file changed, 20 insertions(+), 19 deletions(-) diff --git a/docs/assets/C#NamingGuidelinesTable.md b/docs/assets/C#NamingGuidelinesTable.md index 6284a22e..66c5ba07 100644 --- a/docs/assets/C#NamingGuidelinesTable.md +++ b/docs/assets/C#NamingGuidelinesTable.md @@ -1,21 +1,22 @@ -# C# Naming conventions - quick reference table +# C# Naming Conventions - Quick Reference Table -| Kind | Naming Convention | Examples | -|--------------------------------------|-------------------|--------------------| -| Classes | PascalCase | `class Car{}` | -| Types and Namespaces | PascalCase | `namespace SampleNamespace{}` | -| Parameters | camelCase | `public Car(int odometerMileage, string manufacturer)` | -| Methods | PascalCase | `public void StartEngine()` | -| Properties | PascalCase | `public double FuelLevel { get; set; }` | -| Local Variables | camelCase | `public int yearManufactured;` | -| Local Functions | PascalCase | `private string CalculateMilesUntilEmpty(double fuelLevel)` | -| Private Instance Fields | _IPascalCase | | -| Private Static Field | _PascalCase | | -| Public Constant Field | _PascalCase | | -| Private Constant Field | _PascalCase | | -| Public Static Readonly Fields | _PascalCase | | -| Private Static Readonly Fields | _PascalCase | | -| Public Fields (not recommended) | _PascalCase | `public string Day;` | -| Enum Members | PascalCase | | +| Kind | Naming Convention | Example | +| ------------------------------------ | ----------------- | ------------------------------------------------------------------ | +| Classes | PascalCase | `class Car{}` | +| Types and Namespaces | PascalCase | `namespace SampleNamespace{}` | +| Parameters | camelCase | `public Car(int odometerMileage, string manufacturer)` | +| Methods | PascalCase | `public void StartEngine()` | +| Properties | PascalCase | `public double FuelLevel { get; set; }` | +| Local Variables | camelCase | `public int yearManufactured;` | +| Local Functions | PascalCase | `private string CalculateMilesUntilEmpty(double fuelLevel)` | +| Private Interface Fields | _IPascalCase | | +| Private Instance Fields | _PascalCase | | +| Private Static Field | _PascalCase | | +| Public Constant Field | _PascalCase | | +| Private Constant Field | _PascalCase | | +| Public Static Readonly Fields | _PascalCase | | +| Private Static Readonly Fields | _PascalCase | | +| Public Fields (not recommended) | _PascalCase | `public string Day;` | +| Enum Members | PascalCase | `enum Status { Operational Broken, InShop }` | | Type Parameters | TPascalCase | `public delegate TOutput Converter(TInput from);` | -| Interfaces | IPascalCase | `interface ISampleInterface` | +| Interfaces | IPascalCase | `interface ISampleInterface` | From f1f09a47a469b782e8c2d1c928fc381e793dc43f Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Tue, 8 Feb 2022 17:47:51 -0800 Subject: [PATCH 7/9] Minor Improvements --- docs/assets/C#NamingGuidelinesTable.md | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/docs/assets/C#NamingGuidelinesTable.md b/docs/assets/C#NamingGuidelinesTable.md index 66c5ba07..36797da4 100644 --- a/docs/assets/C#NamingGuidelinesTable.md +++ b/docs/assets/C#NamingGuidelinesTable.md @@ -3,20 +3,13 @@ | Kind | Naming Convention | Example | | ------------------------------------ | ----------------- | ------------------------------------------------------------------ | | Classes | PascalCase | `class Car{}` | -| Types and Namespaces | PascalCase | `namespace SampleNamespace{}` | +| 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 | `public int yearManufactured;` | | Local Functions | PascalCase | `private string CalculateMilesUntilEmpty(double fuelLevel)` | -| Private Interface Fields | _IPascalCase | | -| Private Instance Fields | _PascalCase | | -| Private Static Field | _PascalCase | | -| Public Constant Field | _PascalCase | | -| Private Constant Field | _PascalCase | | -| Public Static Readonly Fields | _PascalCase | | -| Private Static Readonly Fields | _PascalCase | | -| Public Fields (not recommended) | _PascalCase | `public string Day;` | -| Enum Members | PascalCase | `enum Status { Operational Broken, InShop }` | +| Fields | _PascalCase | `public string _Day;` | +| Enum Members | PascalCase | `enum Status { Operational, Broken, InShop }` | | Type Parameters | TPascalCase | `public delegate TOutput Converter(TInput from);` | | Interfaces | IPascalCase | `interface ISampleInterface` | From 4c6191051e4d4853b3549404a3857af6314a9586 Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Mon, 14 Feb 2022 10:08:47 -0800 Subject: [PATCH 8/9] Minor changes from code review Co-authored-by: Kevin B Update docs/assets/C#NamingGuidelinesTable.md Co-authored-by: Kevin B Update docs/assets/C#NamingGuidelinesTable.md Co-authored-by: Kevin B Update docs/assets/C#NamingGuidelinesTable.md Co-authored-by: Kevin B Update docs/assets/C#NamingGuidelinesTable.md Co-authored-by: Kevin B --- docs/assets/C#NamingGuidelinesTable.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/assets/C#NamingGuidelinesTable.md b/docs/assets/C#NamingGuidelinesTable.md index 36797da4..4ca2ab5e 100644 --- a/docs/assets/C#NamingGuidelinesTable.md +++ b/docs/assets/C#NamingGuidelinesTable.md @@ -3,13 +3,13 @@ | Kind | Naming Convention | Example | | ------------------------------------ | ----------------- | ------------------------------------------------------------------ | | Classes | PascalCase | `class Car{}` | -| Types and Namespaces | PascalCase | `namespace VehicleManufacturer{}` | +| 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 | `public int yearManufactured;` | -| Local Functions | PascalCase | `private string CalculateMilesUntilEmpty(double fuelLevel)` | +| Local Variables | camelCase | `int yearManufactured;` | +| Local Functions | PascalCase | `string CalculateMilesUntilEmpty(double fuelLevel)` | | Fields | _PascalCase | `public string _Day;` | -| Enum Members | PascalCase | `enum Status { Operational, Broken, InShop }` | -| Type Parameters | TPascalCase | `public delegate TOutput Converter(TInput from);` | +| Enum Members | PascalCase | `enum Status { Unknown, Operational, Broken, InShop }` | +| Type Parameters | TPascalCase | `public TOutput Convert(TInput from)` | | Interfaces | IPascalCase | `interface ISampleInterface` | From b969b9afee0db1d12e032b15128890331eefaa61 Mon Sep 17 00:00:00 2001 From: Benjamin Michaelis Date: Mon, 14 Feb 2022 10:10:25 -0800 Subject: [PATCH 9/9] Minor changes --- docs/assets/C#NamingGuidelinesTable.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/assets/C#NamingGuidelinesTable.md b/docs/assets/C#NamingGuidelinesTable.md index 4ca2ab5e..896bb3ee 100644 --- a/docs/assets/C#NamingGuidelinesTable.md +++ b/docs/assets/C#NamingGuidelinesTable.md @@ -2,14 +2,14 @@ | Kind | Naming Convention | Example | | ------------------------------------ | ----------------- | ------------------------------------------------------------------ | -| Classes | PascalCase | `class Car{}` | -| Types and Namespaces | PascalCase | `namespace VehicleManufacturer;` | +| 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 | `public string _Day;` | -| Enum Members | PascalCase | `enum Status { Unknown, Operational, Broken, InShop }` | -| Type Parameters | TPascalCase | `public TOutput Convert(TInput from)` | +| 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 from)` | | Interfaces | IPascalCase | `interface ISampleInterface` |