HighFile-scopeC# Plug & play

XML documentation for public APIs

All public types and members must have XML documentation comments with <summary>, <param>, <returns> (if non-void), and <exception> when thrown.

Add to Mesrai Open workspace

Why this matters

Enables IntelliSense and consistent API usage across assemblies.

Bad vs. good

Side-by-side examples engineers can pattern-match during review.

Avoid

public int Add(int a, int b) { return a + b; }

Prefer

/
 * Add two integers.
 * @param a First addend.
 * @param b Second addend.
 * @returns Sum of a and b.
 /
public int Add(int a, int b) { return a + b; }

More snippets

Good

/
 * Find by id.
 * @param id External ID.
 /
public User Find(string id){ ... }

Bad

// Find by id
public User Find(string id){ ... }

Related rules

From the same buckets as this rule.

Critical
Avoid Returning Null in Non-Async Task Methods
Returning null from a Task or Task<T> method causes a NullReferenceException if awaited. Use Task.CompletedTask or Task.FromResult<T>(null) instead.
error-handlingreadability-refactor+1
Critical
Prefer `str.replace()` Over `re.sub()` for Simple Cases
Detect uses of `re.sub()` where regular expressions are not needed. For simple string replacements, `str.replace()` is more efficient and should be used instead.
performance-efficiencystack-python+1
Critical
Use Factory Method Injection in `@Configuration` Classes
Ensure that factory method injection is used in `@Configuration` classes instead of `@Autowired` field injection.
module-architecturestyle-conventions

Why this matters

Bad vs. good

More snippets

Related rules

Avoid Returning Null in Non-Async Task Methods

Prefer `str.replace()` Over `re.sub()` for Simple Cases

Use Factory Method Injection in `@Configuration` Classes

Why this matters

Bad vs. good

More snippets

Related rules

Avoid Returning Null in Non-Async Task Methods

Prefer `str.replace()` Over `re.sub()` for Simple Cases

Use Factory Method Injection in `@Configuration` Classes