dotnet/roslyn

Case sensitivity check for xml documentation tags is wrong

Open

#7,822 opened on Jan 7, 2016

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C# (20,414 stars) (4,257 forks)batch import
Area-CompilersBugTenet-Compatibilityhelp wanted

Description

When compiling C# code, roslyn ignores cases for XML Document tags. On the other hand, roslyn is case sensitive when processing VB code.

An example:

\\\ <Summary> Simple test method</Summary>
\\\ <Param name="parameter">A sample parameter </Param>
\\\ <returns> The value of parameter</returns> 
public static bool TestMethod(bool parameter){ return parameter; }

This will compile fine in VS2015, but not VS2013. The documentation comments are also illegal for VB now. We discovered this, because a <Param>-tag inside our documentation caused the build to fail when we tested VS2015. We also believe that the implemented behavior is backwards to what it should be, as C# is usually case sensitive, while VB is not.

See file src/Compilers/Core/Portable/InternalUtilities/DocumentationCommentXmlNames.cs, the method ElementEquals(), line 40.

Contributor guide

Tech stack
csharp
Domain
tooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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# programmingUnderstanding of XML doc comments
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the `ElementEquals` method in `DocumentationCommentXmlNames.cs`. Determine how the current comparison is performed and modify it to handle case sensitivity correctly based on the language (C# vs VB). Look for any existing tests related to XML doc tag processing. The issue comments may provide additional context.