设置DataContract成员的描述

Question

我想控制帮助页面上的内容，尤其是关于每个字段的信息。例如，我有这样一个类：

[DataContract(Name = "MH")]
public class MessageHeader 
{
    [DataMember(Name = "I")]
    public Guid Id { get; set; }
    [DataMember(Name = "CI")]
    public Guid ChannelId { get; set; }
    [DataMember(Name = "CR")]
    public double Created { get; set; }
    [DataMember(Name = "CTI")]
    public int ContentTypeId { get; set; }
    [DataMember(Name = "S")]
    public string Subject { get; set; }
    [DataMember(Name = "EC")]
    public bool Encrypted { get; set; }
    [DataMember(Name = "E")]
    public double Expire { get; set; }
}

我尝试添加DescriptionAttribute，但它没有显示在帮助页面上。知道如何为每个字段添加描述吗？

Answer 1

我从未这样做过，但您可以使用CustomContractConverter来增强WSDL。这是转换器的MSDN文档，它肯定不像一个属性那么简单，但因为默认情况下没有为DataContracts提供描述，所以这可能是你的最佳选择。

Answer 2

您可能正在寻找像Sandcastle这样的文档工具，当前版本在这里。

这会根据您的代码和代码注释自动创建文档文件：

项目描述Sandcastle产生准确的MSDN风格，通过对源程序集进行反思来编制全面的文档以及可选地集成XML文档注释。Sandcastle以下关键功能：

• 使用或不使用编写的注释

为了让你开始，这里有一个"5分钟的Sandcastle教程：构建C#代码文档"（Andrew Stellman，O'Reilly Community）。