Results 1 to 3 of 3

Thread: [RESOLVED] Q regarding documenting

  1. #1

    Thread Starter
    Fanatic Member
    Join Date
    May 2005
    Posts
    898

    Resolved [RESOLVED] Q regarding documenting

    Hi, I'm attempting to make use of the commenting facility in C# and I have a question that strangely enough I can't figure out for myself.
    The following comments belonging to a property will display in intellisense just fine, but what tags should I use to make my description appear below the propertygrid as well?

    Code:
    		/// <summary>
    		/// Gets or sets second color of the focus state gradient.
    		/// </summary>
    		public Color	GradientFocusColor2	
    		{
    			get {return msettings.GradientFocusColor2 ;}
    			set {msettings.GradientFocusColor2 = value;CreateGradientBrushes();this.Invalidate();}
    		}
    Thanks for wasting your time on this
    "so just keep in mind that fantasy is not the same as realtiy and make sure u remember that wii sports may be fun but u cant count on it as exercise ok cool bye" - HungarianHuman

  2. #2
    Fanatic Member Blade's Avatar
    Join Date
    Jan 1999
    Location
    Stoke-on-Trent, UK
    Posts
    527

    Re: Q regarding documenting

    You need to use the DescriptionAttribute, like so:
    Code:
    		/// <summary>
    		/// Gets or sets second color of the focus state gradient.
    		/// </summary>
    		[DescriptionAttribute("Gets or sets second color of the focus state gradient.")]
    		public Color	GradientFocusColor2	
    		{
    			get {return msettings.GradientFocusColor2 ;}
    			set {msettings.GradientFocusColor2 = value;CreateGradientBrushes();this.Invalidate();}
    		}

  3. #3

    Thread Starter
    Fanatic Member
    Join Date
    May 2005
    Posts
    898

    Re: Q regarding documenting

    thx _ _
    "so just keep in mind that fantasy is not the same as realtiy and make sure u remember that wii sports may be fun but u cant count on it as exercise ok cool bye" - HungarianHuman

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  



Click Here to Expand Forum to Full Width