Roslyn: [BUG] Can't use left shift operator in XML doc comments

Created on 14 Aug 2018  路  2Comments  路  Source: dotnet/roslyn

Version Used:
Visual Studio Professional 2017 Preview
Version 15.8.0 Preview 5.0

Steps to Reproduce:

  1. Write code for a variable or method
  2. Write a XML documentation (summary) to the method
  3. Write a left shift operator into the XML documentation

Expected Behavior:

  • A left shift (and right shift) operator should be accept inside the XML documentation and not parsed to a possible HTML tag

Actual Behavior:

  • The left shift operator is interpreted as start signs of a HTML tag
  • Hover on the variable or method don't show any information
    2018-08-14 07_59_54-webvis - microsoft visual studio preview

Current workaround

  • Replace the left shift operator with a word group
    2018-08-14 08_03_15-webvis - microsoft visual studio preview
Area-Language Design Resolution-By Design

Most helpful comment

@CyrusNajmabadi is correct. These characters need to be XML-escaped within an XML documentation comment.

All 2 comments

Use <

This is an 'xml' doc comment. So the rules of xml apply here.

@CyrusNajmabadi is correct. These characters need to be XML-escaped within an XML documentation comment.

Was this page helpful?
0 / 5 - 0 ratings