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スタイルの包括的なドキュメントを作成します。Sandcastleには次の主要な機能があります。

  • 作成されたコメントの有無にかかわらず動作します

はじめに、「5分間のSandcastleチュートリアル：C＃コードドキュメントの作成」（Andrew Stellman、O'Reilly Community）をご覧ください。

于 2012-08-28T10:24:34.990 に答える
1

私はこれを行ったことがありませんが、CustomContractConverterを使用してWSDLを拡張できる可能性があります。これがコンバーターのMSDNドキュメントです。これは、属性ほど単純ではありませんが、DataContractsのデフォルトの説明がないため、これが最善の策かもしれません。

于 2012-08-28T16:58:28.020 に答える