2

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

[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 但它没有显示在帮助页面上。知道如何为每个字段添加描述吗？

4

2 回答 2

1

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

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

项目描述 Sandcastle 通过反映源程序集和可选地集成 XML 文档注释来生成准确的 MSDN 风格的综合文档。沙堡有以下主要特点：

  • 有或没有作者评论的作品

为了帮助您入门，这里有一个“ 5 分钟的 Sandcastle 教程：构建 C# 代码文档”（Andrew Stellman，O'Reilly 社区）。

于 2012-08-28T10:24:34.990 回答
1

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

于 2012-08-28T16:58:28.020 回答