dotnet/roslyn

Case sensitivity check for xml documentation tags is wrong

Open

#7.822 geöffnet am 7. Jan. 2016

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C# (4.257 Forks)batch import
Area-CompilersBugTenet-Compatibilityhelp wanted

Repository-Metriken

Stars
 (20.414 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (256 gemergte PRs in 30 T)

Beschreibung

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