HighFile-scopeJava Plug & play

Javadoc required for public types and methods

All public classes, interfaces, and methods must include Javadoc with a summary sentence, @param for each parameter, @return when not void, and @throws where applicable.

Add to Mesrai Open workspace

Why this matters

Javadoc powers IDE help and stable API contracts.

Bad vs. good

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

Avoid

public class UserService {
 public User find(String id) { ... }
}

Prefer

/* Service for user retrieval. /
public class UserService {
 /**
 * Find a user by ID.
 * @param id external identifier
 * @return the user
 * @throws NotFoundException if no user exists
 /
 public User find(String id) { ... }
}

More snippets

Good

/ Compute sum. @param a @param b @return sum /
public int add(int a, int b){ return a + b; }

Bad

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

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