如何记录c#dll

时间:2010-02-03 15:27:54

标签: c# class dll attributes

如何编写一个类,以便在其他项目中引用dll的人可以看到属性和方法描述?

    [Description("My age in years attribute")]
    public int Age
    {
        get { return 0; }
        set { }
    }

不起作用,

也不起作用
    /// <summary>
    /// My age in years attribute
    /// </summary>
    public int Age
    {
        get { return 0; }
        set { }
    }

4 个答案:

答案 0 :(得分:14)

在Visual Studio中:

  

项目 - &gt;属性 - &gt;构建 - &gt;检查“XML文档文件”。

有关详细信息,请参阅XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files

答案 1 :(得分:1)

DescriptionAttribute中提供的说明在Property Grid中是可见的,它与代码编辑器无关。

要使XML注释可用,您必须generate an XML documentation file并将其与您的程序集一起发送。

答案 2 :(得分:1)

你为第二种情况构建了XML documentation file吗?

  

项目属性 - &gt;构建 - &gt; [输出] XML文档文件

答案 3 :(得分:1)

第二个应该工作(摘要),一定要在项目属性(Build - &gt; Output)XML文档文件中选择。