Multi-line style comments causing XML documentation warning

Question

I have many multi-line style comments in a C# project and when the project option is set to output a XML documentation file they all trigger the warning XML comment is not placed on a valid language element. This behaviour is observed in Visual Studio 2010.

Short of changing all these comments to single-line style comments what can I do to prevent these warnings from being triggered?

Reduced example:

public class Foo
{
    /// <summary>
    /// Does something.
    /// </summary>
    public void DoSomething()
    {
        /**
         * Do something interest here.
         */
    }
}

Something to do with the double star? That's like a doc-comment in Java... change it to /* instead of /** — jonnystoten
– jonnystoten, Commented Feb 15, 2013 at 16:58

SLaks · Accepted Answer · 2013-02-15 16:58:02Z

10

Just remove the second * on the first line of the comment.

C-style XML doc comments are opened with /**.

answered Feb 15, 2013 at 16:58

SLaks

891k182 gold badges1.9k silver badges2k bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Altair Over a year ago

I see, only /** triggers the warning, any other amount of * in the first line does not trigger the warning. Thanks @SLaks and @applechewer.

Collectives™ on Stack Overflow

Multi-line style comments causing XML documentation warning

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related