-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Issue #19: Incorrect Comments
Type: Documentation Smell
Files: Program.cs
Problematic Examples:
- Redundant comment:
// Configure LoggerFactory to suppress detailed logs
var loggerFactory = LoggerFactory.Create(...) // Obvious from code
- Missing documentation:
public BlogPost(string title) // No XML doc about null handling
Solution:
/// <summary>
/// Initializes blog post with required title
/// </summary>
/// <exception cref="ArgumentNullException">Thrown if title is null/empty</exception>
public BlogPost(string title)
Metadata
Metadata
Assignees
Labels
No labels