标签: xml-documentation

我正在使用Visual Studio 2005(VS.8.0),我希望强制要求记录所有类成员,而不仅仅是公共成员.虽然公共,受保护或受内部保护的成员没有记录,但设置Visual Studio以生成警告是微不足道的,我正在寻找一种让私有和内部成员抛出相同警告的方法.有什么建议？

注意:我正在使用警告级别4,将警告视为错误,并设置了生成XML标志.

假设我有一个像这样定义的附加属性:

    public static string GetMyProperty(DependencyObject obj)
    {
        return (string)obj.GetValue(MyPropertyProperty);
    }

    public static void SetMyProperty(DependencyObject obj, string value)
    {
        obj.SetValue(MyPropertyProperty, value);
    }

    // Using a DependencyProperty as the backing store for MyProperty.  This enables animation, styling, binding, etc...
    public static readonly DependencyProperty MyPropertyProperty =
        DependencyProperty.RegisterAttached("MyProperty", typeof(string), typeof(MyClass), new UIPropertyMetadata(0));

我可以编写属性identifier(MyPropertyProperty)和访问器(GetMyProperty和SetMyProperty)的文档,但我不知道在哪里放置MyClass.MyProperty附加属性的文档,因为它不是一个实际的代码元素.

MSDN库包含此类文档(例如Grid.Row,参见参考资料),因此必须可以......

我应该在哪里放置附加属性的XML文档注释？

在使用C#中的Web客户端软件工厂(WCSF)处理ASP.net Web应用程序时,我遇到了这种困境,同样适用于其他平台和语言.我的情况是这样的:

我正在为基于WCSF范例的每个网页/用户控件定义一个I View界面,然后让页面类实现I View界面,基本上实现界面中定义的每个方法.当我尝试在方法级别添加xml文档时,我发现自己基本上重复了接口方法的相同注释内容,以及它在实现类中的反向部分.

所以我的问题是:接口方法的文档内容和相应的类方法之间是否存在一些实质性的区别？他们应该在不同方面强调什么？

有人告诉我,接口方法注释应该说该方法应该做什么,而类方法注释应该说"它是如何做的".但是我记得在之前的某处读过方法级别注释应该只说"该方法应该做什么",而不是方法的实现细节,因为实现不应该是方法用户的关注,它可能会改变.

我有这个功能:

public static string Join(this IEnumerable<string> strings, string separator)
{
    return string.Join(separator, strings.ToArray());
}

我要记录.
我希望<return>标签能够说明,string.Join(separator, strings.ToArray())因为任何能够阅读C#代码的人都会说超过一千个单词.但是,当我使用时

<return>string.Join(separator, strings.ToArray())</return>

然后string.Join(separator,strings.ToArray())将被格式化为纯文本,这使得它几乎不可读.所以我试过了

<return><code>string.Join(separator, strings.ToArray())</code></return>

但这总是创造一个新的段落......

所以这是我的问题:
有没有办法格式化一段文本,使它看起来好像是代码？我对固定宽度的字体感到满意.

我不知道是否可能,但我想知道是否有办法将代码和文档保存在单独的文件中,但仍然与通常使用内联文档相同.

我正在尝试使用Web Deploy发布.NET Web服务.目前,它包含了包中的XML文档文件.我在Visual Studio的项目属性的Build选项卡中取消选中"XML文档文件".这会阻止发布XML文件,但该项目引用了许多具有XML文档的自定义库.

显然,我们不想关闭自定义库的文档.也没有理由部署这些XML文件.

从msdeploy/msbuild命令行或项目属性中,如何防止XML文档文件包含在包和后续Web部署中？

更新

我已经尝试添加DEL /Q "$(TargetDir)*.xml"到构建前和构建后的事件但没有成功.XML文件仍添加到包中.

如何在Eclipse中生成我的C#Web应用程序的文档,就像Eclipse一样？

我的一个方法有以下XML文档段:

    /// <summary>
    /// Calculates the total charge for hours between the <see cref="StartDateTime"/> and <see cref="EndDateTime"/> of all all the <see cref="VehiclePresence"/> records 
    /// included in the date range defined by <paramref name="startDate"/> and <paramref name="endDate"/>.
    /// </summary>

该<see cref="StartDateTime"/>部分呈现为[!:StartDateTime].我希望它作为VehiclePresence.StartDatetTime属性文档<see cref="VehiclePresence"/>的链接呈现,就像该部分呈现为VehiclePresence类的文档的链接一样.

我的情况:
所以,上周我用ILSpy将.NET程序集反编译成C#; 从那时起,我已经投入大量精力来按摩文件/项目等,以便它们都能正常工作(有很多小错误[主要由ILSpy的代码生成过程引起]和随机问题而且我我一直在修理它们.我现在距离我的目标只有几英寸,看到终点线!

但是,瞧瞧:我刚刚意识到所有的XML评论都缺失了.> <

我做了一些淘洗,我能够找到.xml智能文件,里面有所有Visual Studio生成的注释.

我想要完成的内容:
我希望将生成的.xml智能文件中的这些注释复制回源文件(当然,这是自动化的,因为在这个程序集中有大约5000个类).

我的问题:
我该怎么办？是否有任何工具可以帮助我自动执行此任务？

我们使用Swagger UI文档来描述我们的项目API.Swagger必须从中读取XML projectname.xml以显示我们在项目中的所有CRUD函数.

问题是当我从Visual Studio切换到Visual Studio代码时,它不会从Visual Studio代码重新生成或更改现有的XML文件.有没有办法在Visual Studio Code中生成XML文档文件,例如在Visual Studio Ultimate中,如下图所示？