IntelliTect / IntelliTect/CodingGuidelines

Fixer for INTL0101 deletes xmldoc comments on method

Open
#136 1 comment 0 reactions 0 assignees View on GitHub
analyzer bug proposal
Dominant language
C#
Stars
12
Forks
16
Avg merge
2m
Merged PRs (30d)
7

Description

Have a method like so:

``` c#
///
/// Does foo
///
[AttributeOne, AttributeTwo]
public async Task FooAsync()
{

}
```

Then, apply the fixer for INTL0101. The comment on the method is deleted.

Contributor guide

Open the contributing guide

Research direction

Start by locating the INTL0101 fixer and reproduce the provided C# example with its XML documentation and attributes. The fix is done when applying the fixer preserves the method's xmldoc comment; add or update a regression test if the fixer has tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.