Add a description for a property

前端 未结 2 2101
长发绾君心
长发绾君心 2021-02-19 18:44

How do I add a text description for my property?

\"alt

My code :

private bool _Space         


        
相关标签:
2条回答
  • 2021-02-19 19:02

    Have a look at the Description Attribute:

    [Description("This is the description for SpaceKey")]
    public bool SpaceKey { get; set; }
    

    You can additionally use the Category Attribute to specify the category of the property:

    [Category("Misc")]
    [Description("This is the description for SpaceKey")]
    public bool SpaceKey { get; set; }
    
    0 讨论(0)
  • 2021-02-19 19:17

    If you want to see the description in the Visual Studio designer (or any other compatible IDE), you'll need to use design-time attributes for components which are defined in System.ComponentModel namespace.

    [Description("This is the description of Space Key.")]
    public bool SpaceKey { get; set; }
    

    Before doing so, consider learning how to write a good description from descriptions in class library (though they're not always helpful, either). It's good to follow the existing style.

    If you want to see hints in code, like tooltips when selecting a member with IntelliSense, you need to also use XML comments for documentation:

    /// <summary>
    /// Gets or sets space key (that would probably make a bad summary).
    /// </summary>
    public bool SpaceKey { get; set; }
    

    That's it.

    0 讨论(0)
提交回复
热议问题