KONGOR C# Coding Standards

Enforce Project KONGOR's C# coding standards including British English, explicit type usage, acronym casing rules, lambda formatting, and comprehensive syntax conventions.

Naming Conventions

**Type Keywords**

Never use `var` - always use explicit type names

Use full words for symbols - never abbreviations (use `configuration` not `config`, `administrator` not `admin`)

**Acronym Casing**

PascalCase: Always uppercase acronyms/initialisms (e.g., `UserID`, `GetGUID`, `HTMLParser`)

camelCase: Only uppercase if NOT at start (e.g., `userGUID`, `accountID`, `httpStatusCode`)

**Lambda Parameters**

Always use full descriptive names - never single letters

✅ `numbers.Select(number => number * number)`

❌ `numbers.Select(x => x * x)`

**Async Methods**

Only use `Async` suffix when both sync and async versions exist in same scope

Formatting Rules

**Indentation & Whitespace**

Always use 4 spaces for indentation

Always terminate files with newline character

Keep vertical whitespace consistent with surrounding code

**Switch Expressions**

Align lambda operators (`=>`) vertically:

```csharp

return UserType switch

{

UserType.Staff => "internal",

UserType.Client => "external",

_ => throw new ArgumentOutOfRangeException($"Unsupported User Type \"{UserType}\"")

};

```

Documentation Standards

**Comments**

Use StartCase for comments (except acronyms/symbol names)

Enclose symbol/branch names in double quotes unless using `<see cref="..."/>`

Only comment non-obvious code that needs context

Example: `// This Is A Sample Comment Explaining The Purpose Of The "request" Variable`

**XML Documentation**

Use sentence case with proper indentation and punctuation

End each sentence with punctuation mark

When referencing methods with `<see cref="..."/>`, omit parameters

```csharp

/// <summary>

/// This method retrieves user information based on the provided user ID.

/// It does so by using the "request" variable from the HTTP handler.

/// </summary>

```

Code Quality Guidelines

**Null Handling**

Never use null-forgiving operator (`!`) except:

- Entity Framework `Include`/`ThenInclude` for navigation properties

- Assigning `null!` when unavoidable and runtime null is impossible

**Using Directives**

Prefer global using directives in `Internals/UsingDirectives.cs`

Keep in lexicographic ascending order, grouped by assembly

Use `global using` syntax (not `global::` alias)

```csharp

global using Aspire.Hosting;

global using Microsoft.Extensions.DependencyInjection;

```

Code Generation Principles

1. **Correctness**: Ensure syntactically correct code adhering to language best practices

2. **Performance**: Optimize for efficiency unless readability suffers significantly

3. **Security**: Follow best practices to prevent injection attacks, data leaks, unauthorized access

4. **Consistency**: Match existing codebase style, conventions, and architecture

5. **Simplicity**: Prefer clarity over complexity - avoid over-engineering

6. **Targeted**: Keep code focused on objectives without unnecessary features

7. **Minimalism**: Avoid unnecessary abstractions or components

Language Requirements

Always use British English for all code and comments

Use "TRUE", "FALSE", "NULL" in comments when referring to literals (to distinguish from natural language)

Constraints

Inspect proximity code to match existing patterns

Check online sources/documentation when uncertain about standards

Present options to user when approach is ambiguous

Verify compliance with latest language standards and security practices

KONGOR C# Coding Standards

KONGOR C# Coding Standards

Naming Conventions

Formatting Rules

Documentation Standards

Code Quality Guidelines

Code Generation Principles

Language Requirements

Constraints

Reviews (0)