C#中的注释要好好加以利用，这样就能做出带有注释的Dll或者控件，方便使用。

设计类的时候：

/// <summary>
/// MyClass的说明
/// </summary>
public class MyClass
{
    /// <summary>
    /// 渐变前景色
    /// </summary>
    private Color froColor;    //这是给成员写注释

    /// <summary>
    /// 渐变背景色
    /// </summary>
    public Color backColor;    //这是给成员写注释

    /// <summary>
    /// Add方法的说明
    /// </summary>
    /// <param name="num1">第一个数</param>
    /// <param name="num2">第二个数</param>
    /// <returns>返回相加的结果</returns>
    public int Add(int num1, int num2)    //这是给方法写注释
    {
        //这是普通的注释
        /*这是块注释
        第二行
        第三行
        第四行*/
    }

    /// <summary>
    /// 获取或设置姓名
    /// </summary>
    public string Name    //这是给属性写注释
    {
        get
        {
            return m_Name;
        }
        set
        {
            m_Name=value;
        }
    }
}

这样，当你实例化一个类的时候，该实例在代码编辑器里就会看到其方法、属性、参数等均有注释出现，就是那种黄色的小方框。如图：
如果是编译成组件让他人使用，则编译时应设定输出的XML文件名，这样注释就存在于XML文件中，别人引用这个dll时同样会看到注释了。
具体方法是：在VS中，点击[项目]–[XXXXXXXX 属性]–[配置属性]–[生成]–[XML 文档文件]，在里面输入文件名就可以了。但是一定要注意，XML的主文件名一定要和生成的DLL的主文件名一致，如：MyClass.dll，就要生成MyClass.xml。

注：只需在类、方法、属性前输入“///”，VS就会将后面的模版自动完成

设计控件时：

[DefaultValue("Button1"),Description("设定文本"),Category("Appearance")]
public string Text
{
    get
    {
        return m_Text;
    }
    set
    {
        m_Text=value;
    }
}

这样就能在VS的窗体编辑器里，看到自定义控件的属性、默认值、描述。后面的Category是设定将这个属性放到哪个类别里（中文版里就是控件属性窗体里的“外观”、“数据”、“设计”、“焦点”、“布局”等分类）。

好了，关于C#里的注释就写这么多了。以后有了再补充。

阅读(440 次)