Define coding guidelines

[Brend-Smits]

In GitLab by @Brend-Smits on Mar 27, 2020, 12:34

We need to define coding guidelines:

• Commenting
• Readability of code (one-liners if statements)
• Method Naming

Related Epic: https://git.fhict.nl/dex/dex-epics/-/issues/14

[Brend-Smits]

In GitLab by @Brend-Smits on Mar 27, 2020, 12:34

changed due date to March 30, 2020

[Brend-Smits]

In GitLab by @jcoenen96 on Mar 27, 2020, 12:43

We can use the free ReSharper command line tools to add linting to our project.
https://www.jetbrains.com/resharper/features/command-line.html
Maybe we can even enforce our settings using the pipeline.

[Brend-Smits]

In GitLab by @jcoenen96 on Mar 27, 2020, 12:43

assigned to @jcoenen96

[Brend-Smits]

In GitLab by @jcoenen96 on Mar 27, 2020, 12:43

unassigned @jcoenen96

[Brend-Smits]

In GitLab by @jcoenen96 on Mar 27, 2020, 15:51

mentioned in merge request !11

[Brend-Smits]

In GitLab by @Brend-Smits on Mar 29, 2020, 20:19

changed the description

[Brend-Smits]

In GitLab by @Brend-Smits on Mar 30, 2020, 13:50

Follow the following convention. There are a few exceptions: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions
Comments:

• Auto generate via visual studio (triple slash (/)), make sure parameters and return are added. Description should also be added. See: https://docs.google.com/document/d/1Tk_UDII39lStYoOoeLYddvGtGnseVOnCa0ybcYFGEkw/edit?usp=sharing
• Parameters, name should describe what the parameter is here for.
• Methods, method name should describe what the method does.

Types:

• Do not use var

Controller:

• Returns Not Found when you request something and it does not exist, not found should be returned. Not No-Content.
• Endpoints and method names should not do: "User.GetUserEmail" but instead use "User.GetEmail"
• Endpoints are in "Single" /api/project/ instead of /api/projects/
• ResourceResult should be returned on a request
• Resource should be used for input on a request

Single liners:

• No single line if-else statements
• Operators are allowed

General rules:

• something < 1 or something <= 0 are both allowed, no discussion needed
• Avoid If-else-elseif chains
• Returns are allowed whenever. No preference.
• Use Literal everything (string, int, etc)
• Line ending: CLRF (Windows)
• Casing: https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions

[Brend-Smits]

In GitLab by @Brend-Smits on Mar 30, 2020, 13:50

closed

[Brend-Smits]

In GitLab by @Brend-Smits on Apr 15, 2020, 11:08

Private and Readonly fields should start with an underscore _