dotnet/roslyn

Incorrect IDE0015 "use framework type" recommendation for built-in type in XML doc comment.

Open

#21,758 opened on Aug 27, 2017

View on GitHub
 (5 comments) (0 reactions) (0 assignees)C# (20,414 stars) (4,257 forks)batch import
Area-IDEBugFeature - IDE0015Feature - IDE0049help wanted

Description

Version Used: VS 15.4.0 Preview 1.0

Steps to Reproduce:

  1. Use an .editorconfig file with the following settings:
dotnet_style_predefined_type_for_locals_parameters_members = true:suggestion
dotnet_style_predefined_type_for_member_access = false:suggestion
  1. Add the following method to a class:
/// <summary>
/// Runs <see cref="Test(Action{int})"/> with <see cref="Int32.MaxValue"/>.
/// </summary>
public void Test(Action<int> action)
{
    action(Int32.MaxValue);
}

Expected Behavior: No code style recommendations.

Actual Behavior: The first int in the doc comment is marked with IDE0015: Use framework type, when instead it should be treated similarly to the int in the method signature, i.e. no suggested style change.

Contributor guide

Tech stack
csharp
Domain
toolingdeveloper experience
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C#Roslyn code analysisXML doc commentseditorconfig
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
Investigate the IDE0015 analyzer implementation in Roslyn, focusing on how it handles XML doc comment content. Look for where the analyzer checks <see cref> elements and ensure that built in type references are treated consistently with code contexts. The fix likely involves modifying the condition that triggers the 'use framework type' suggestion to exclude doc comments or align it with the method signature handling.