Share xml-documentation accross overloads

Posted by Kurresmack on Stack Overflow See other posts from Stack Overflow or by Kurresmack
Published on 2010-03-15T20:41:46Z Indexed on 2010/03/15 20:49 UTC
Read the original article Hit count: 311

Filed under:

c#

|

parameters

|

documentation

Hey,

is there a way to share xml-documentation of the parameters to all the overloads? Lets say I have 10 overloads of a method but they all share the first 5 parameter (I use C# so I cannot have optional parameters).

How do I do so that I do not have to write the same text for all of the parameters?

© Stack Overflow or respective owner

Related posts about c#

.NET WebRequest.PreAuthenticate not quite what it sounds like

as seen on West-Wind - Search for 'West-Wind'
I’ve run into the problem a few times now: How to pre-authenticate .NET WebRequest calls doing an HTTP call to the server – essentially send authentication credentials on the very first request instead of waiting for a server challenge first? At first glance this sound like it should be easy:… >>> More
HttpWebRequest and Ignoring SSL Certificate Errors

as seen on West-Wind - Search for 'West-Wind'
Man I can't believe this. I'm still mucking around with OFX servers and it drives me absolutely crazy how some these servers are just so unbelievably misconfigured. I've recently hit three different 3 major brokerages which fail HTTP validation with bad or corrupt certificates at least according to… >>> More
The dynamic Type in C# Simplifies COM Member Access from Visual FoxPro

as seen on West-Wind - Search for 'West-Wind'
I’ve written quite a bit about Visual FoxPro interoperating with .NET in the past both for ASP.NET interacting with Visual FoxPro COM objects as well as Visual FoxPro calling into .NET code via COM Interop. COM Interop with Visual FoxPro has a number of problems but one of them at least got a lot… >>> More
Dynamic Type to do away with Reflection

as seen on West-Wind - Search for 'West-Wind'
The dynamic type in C# 4.0 is a welcome addition to the language. One thing I’ve been doing a lot with it is to remove explicit Reflection code that’s often necessary when you ‘dynamically’ need to walk and object hierarchy. In the past I’ve had a number of ReflectionUtils that used string based expressions… >>> More
Finding a Relative Path in .NET

as seen on West-Wind - Search for 'West-Wind'
Here’s a nice and simple path utility that I’ve needed in a number of applications: I need to find a relative path based on a base path. So if I’m working in a folder called c:\temp\templates\ and I want to find a relative path for c:\temp\templates\subdir\test.txt I want to receive back subdir\test… >>> More

Related posts about parameters

Application pool crashing regularly (8007006d) (Service Unavailable)

as seen on Stack Overflow - Search for 'Stack Overflow'
I have a basic web form site running. Nothing out of the ordinary. It is frequently crashing the application pool. The error code I got from the logs is '8007006d'. Googling this does not come up with the usual bevy of results.... I do get a few people with a similar problem. Any the advise seems… >>> More
bonding module parameters are not shown in /sys/module/bonding/parameters/

as seen on Server Fault - Search for 'Server Fault'
I have a server with Suse 11 sp1 kernel 2.6.32.54-0.3-default, with modinfo bonding i see all parameters, but under /sys/module/bonding/parameters/ not modinfo bonding | grep ^parm parm: max_bonds:Max number of bonded devices (int) parm: num_grat_arp:Number of gratuitous ARP packets… >>> More
Whats the difference between Command Parameters and Menu Contribution Parameters

as seen on Stack Overflow - Search for 'Stack Overflow'
I can see that parameters can be defined for Commands defined using the Commands extension point. I can not define a value for these command parameters. I can also define parameters under the Command element in the menus extension point when defining menu contributions. I can define a value for the… >>> More
Using template parameters as template parameters

as seen on Stack Overflow - Search for 'Stack Overflow'
Why is the following code invalid? template <typename S, typename T> struct B{ void f(T t, S s) {t.f<S>(s); } }; gcc 4.3.4 complains that it "expected primary-expression before '' token", i.e. that "S" wasn't a valid primary-expression. >>> More
How do you Send More that 20 Parameters to a Stored Procedure Using ODP.Net?

as seen on Stack Overflow - Search for 'Stack Overflow'
Switching from Microsofts Oracle Driver to ODP.NET version 10.2.0.100. After changing the data types to OracleDBTypes in a procedure, that worked perficetly using System.Data.OracleClient, the procedure fails if we try and pass in more that 20 parameters. The error returned is: ORA-06550: line… >>> More