Прочитать на английском

Поделиться через


Предупреждение компилятора (уровень 1) CS1570

XML-комментарий для "конструкция" содержит некорректный XML — "причина"

При использовании DocumentationFile все примечания в исходном коде должны находиться в ФОРМАТЕ XML. Любая ошибка разметки XML вызывает предупреждение CS1570. Например:

  • Если строка передается в ссылку, например в <теге исключения>, строка должна быть заключена в двойные кавычки.

  • Если вы используете тег, который не имеет закрывающего тега, например <seealso>, необходимо указать косую черту вперед перед закрывающей угловой скобкой.

  • Если в тексте описания необходимо использовать символ "больше" или "меньше", следует представить эти символы как &gt; или &lt;. Кроме того, можно использовать CDATA.

  • Атрибут файла или пути к тегу <включения> отсутствует или неправильно сформирован.

Следующий пример приводит к возникновению предупреждения CS1570:

public static class CompareFive
{
    // the following line generates CS1570
    /// <summary> returns true if < 5 </summary>
    // try one of the following instead
    // /// <summary> returns true if &lt; 5 </summary>
    // /// <summary><![CDATA[ returns true if < 5 ]]></summary>
    public static bool LessThanFive(int x) => x < 5;
}