LowFile-scopeC# Plug & play

Use <inheritdoc/> judiciously and document exceptions explicitly

Use <inheritdoc/> to inherit docs for overrides/implementations, but explicitly add <exception> and behavior differences when applicable.

Add to Mesrai Open workspace

Why this matters

Keeps docs DRY while making runtime differences clear.

Bad vs. good

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

Avoid

/// <inheritdoc/>
public override Task ExecuteAsync(){ ... }

Prefer

/// <inheritdoc/>
/// <exception cref=\"TimeoutException\">When the request exceeds the timeout.</exception>
public override Task ExecuteAsync(){ ... }

More snippets

Good

/// <inheritdoc/>
public override string ToString(){ ... }

Bad

public override string ToString(){ ... }

Related rules

From the same buckets as this rule.

Critical
Avoid Duplicating String Literals
Store repeated string literals in constants or variables to improve maintainability and reduce redundancy.
duplication-complexitymaintainability
Critical
Avoid Empty Methods
Detect methods that have an empty body. If a method is empty, ensure that a comment is present explaining why it remains unimplemented.
maintainabilityreadability-refactor
Critical
Avoid modifying built-in prototypes
Detect modifications to built-in prototypes. Modifying built-in objects can lead to compatibility issues and unexpected behavior. Recommend creating helper functions instead.
maintainabilitysecurity-hardening

Why this matters

Bad vs. good

More snippets

Related rules

Avoid Duplicating String Literals

Avoid Empty Methods

Avoid modifying built-in prototypes

Why this matters

Bad vs. good

More snippets

Related rules

Avoid Duplicating String Literals

Avoid Empty Methods

Avoid modifying built-in prototypes