tags:

views:

26

answers:

2
Q: 

Share xml-documentation accross overloads

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?

A: 

You can't. The task could be automated but the same text will have to be there for the compiler.

David  2010-03-15 20:45:41
What do you mean by automated?
Oskar Kjellin  2010-03-15 20:47:53
I mean that you could write a tool that could populate the XML documentation for your overrides. You would have to run that before you run the compiler.
David  2010-03-15 21:10:18
+1  A: 

This doesn't really answer your question but I find that when I get more then 5-8 overloads it is simpler to provide a simple POCO with every possible argument.

This gives me a place to embed validation and add as many properties as I like at a later date. and its a single place to add xml docs

 2010-03-15 21:09:07
Thanks for a good answer! Might use this in some other case but in this case it is not possible(lots of parameters that I create an object after calling the method which would lead to having to create the object before calling the method each time(which can be many places). I have used this in other projects however and there it works fine to the solution is solid
Oskar Kjellin  2010-03-15 21:15:40

related questions

Displaying Flash content in a C# WinForms application
How to get the value of built, encoded ViewState?
Unhandled Exception Handler in .NET 1.1
How do I connect to a database and loop over a recordset in C#?
How do I most elegantly express left join with aggregate SQL as LINQ query
Get a new object instance from a Type in C#
.NET Testing Framework Advice
Automatically update version number
What is the difference between an int and an Integer in Java/C#?
How to write to Web.Config in Medium Trust ?
WinForms ComboBox data binding gotcha
How do you sort a C# dictionary by value?
Adding Scripting functionality to .NET applications
Floating Point Number parsing: Is there a Catch All algorithm?
How do I print an HTML document from a web service?
Decoding T-SQL CAST in C#/VB.net
Anatomy of a "Memory Leak"
How do I get a distinct, ordered list of names from a DataTable using Linq
Reliable Timer in a Console Application
How do I fill a DataSet or a DataTable from a LINQ query resultset ?
What's the difference between Math.Floor() and Math.Truncate() in .NET?
How do I calculate relative time?
How do I calculate someone's age in C#?
Are there any conversion tools for porting Visual J# code to C#?
When setting a form's opacity should I use a decimal or double?