issue with c# xml documentation

Question

I have the following comment.

    /// <summary>
    /// MSDN Time Format compatible with <see cref="DateTime.ParseExact(string, string, IFormatProvider)"/> 
    /// </summary>
    /// <returns>MSDN Time Format compatible with <see cref="DateTime.ParseExact(string, string, IFormatProvider)"/></returns>

but I'm not sure why I receive the following warning

Warning 7 XML comment on 'MSLab.DateTime.SystemTimeProvider.GetTimeFormat()' has cref attribute 'DateTime.ParseExact(string, string, IFormatProvider)' that could not be resolved F:\My Documents\Visual Studio 2010\Projects\MSLab\trunk\MSLab\MSLab\DateTime\SystemTimeProvider.cs 110 57 MSLab

I copied your code and couldn't reproduce the error. Do you have a using System;? — Dan
– Dan, Commented Aug 31, 2012 at 3:19
Michael Liu caught it as it was very subtle (but right in my face). I have an MSLab.DateTime namespace which was conflicting. It's too bad the warning message did not say "ambiguous" like it does when compiling code in such a manor. — galford13x
– galford13x, Commented Aug 31, 2012 at 3:43

Michael Liu · Accepted Answer · 2012-08-31 03:36:47Z

1

Based on the warning message, it looks like your SystemTimeProvider class is inside a namespace named DateTime, which has the same name as the .NET DateTime type. To resolve this conflict, change your cref to "System.DateTime.ParseExact(string, string, IFormatProvider)":

/// <summary>
/// MSDN Time Format compatible with <see cref="System.DateTime.ParseExact(string, string, IFormatProvider)"/>
/// </summary>
/// <returns>MSDN Time Format compatible with <see cref="System.DateTime.ParseExact(string, string, IFormatProvider)"/></returns>

answered Aug 31, 2012 at 3:36

Michael Liu

55.8k14 gold badges126 silver badges158 bronze badges

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

1 Comment

galford13x Over a year ago

Wow I banged my head for a while and I never even noticed. That namespace needs to be renamed me thinks. Either way providing the fully qualified name did the trick. Thanks!

Collectives™ on Stack Overflow

issue with c# xml documentation

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