c# - Detailed XML Documentation for field. Does it possible? -


i have define callback field , event property it:

private action<int, int, taskcallbackargs> _callbackevent     /// <summary> /// provides callback event task. /// </summary> public event action<int, int, taskcallbackargs> callbackevent {   add   {     _callbackevent += value;   }   remove   {     _callbackevent -= value;   } } 

in code have invoke _callbackevent. right, when type _callbackevent( vs show me intellisense method want (int arg1, int arg2, taskcallbackargs arg3) arguments. when open code time later don't remember arg1, arg2 , arg3.

is there way use xml documentation field following?

/// <summary> /// description /// </summary> /// <param name="current">param description...</param> /// <param name="total">param description...</param> /// <param name="additional">param description...</param> 

thanks!

action<int, int, taskcallbackargs> delegate type takes 3 parameters.
can write xml doc comment field, apply field itself.

to add parameter names , doc comments delegate parameters, need create own delegate type.

for example:

/// <summary> /// description /// </summary> /// <param name="current">param description...</param> /// <param name="total">param description...</param> /// <param name="additional">param description...</param> public delegate void callbackhandler(int current, int total, taskcallbackargs additional); 

Comments

Popular posts from this blog

android - Spacing between the stars of a rating bar? -

html - Instapaper-like algorithm -

c# - How to execute a particular part of code asynchronously in a class -