Compiler Warning (level 1) CS1584

  • Article

XML comment on 'member' has syntactically incorrect cref attribute 'invalid_syntax'

One of the parameters passed to a tag for documentation comments has invalid syntax. For more information, see Recommended Tags for Documentation Comments (C# Programming Guide).

Example

The following sample generates CS1584.

// CS1584.cs
// compile with: /W:1 /doc:CS1584.xml
/// <remarks>Test class</remarks>
public class Test
{
   /// <remarks>Called in <see cref="Test.Mai()n"/>.</remarks>   // CS1584
   // try the following line instead
   // /// <remarks>Called in <see cref="Test.Main()"/>.</remarks>
   public static void Test2() {}

   /// <remarks>Main method</remarks>
   public static void Main() {}
}