|
Well, not only does the current method mean having the same description entered over and over, but it is also prone to errors.
I have a number of these kind of functions where foo() and foo(int x) both end up calling foo(int x, int y). If I make a change to foo(int x, int y) and alter its documentation, I have to make sure that I go back and alter the documentation for the other two - which, sometimes I miss, or do incorrectly.
I was hoping for something more along the lines of
public void foo() {...}
public void foo(int x) {...}
public void foo(int x, int y) {...}
...
Something that would save typing the same function description over and over. And while I'm in pie-in-the-sky-land,
public void goo(int x, int y) {...}
...
Clive Pottinger
Victoria, BC
|
|
|
|
|
Updating documentation is an expensive and time consuming process. Considering the bad results I have seen from automated tools causing developers to use inferred documentation I am a big fan of the manual process.
Also, in general, an overloaded method should do the same thing as all of the other methods but with different parameters. Causing special handling is asking for disaster.
Need a C# Consultant? I'm available.
Happiness in intelligent people is the rarest thing I know. -- Ernest Hemingway
|
|
|
|
|
I know this doesn't help you with the problem at hand, but I think you'll do just fine - you already use and think about documentation FAR more than most people I know. 
Cheers,
Vikram.
The hands that help are holier than the lips that pray.
|
|
|
|
|
You might want to look at the <include>[^] tag.
Scott Dorman Microsoft® MVP - Visual C# | MCPD
President - Tampa Bay IASA
Hey, hey, hey. Don't be mean. We don't have to be mean because, remember, no matter where you go, there you are. - Buckaroo Banzai
[ Forum Guidelines][ Articles][ Blog]
|
|
|
|
|
NDoc supports an "<overloads>" XML comment, but I'm not sure if SandCastle also supports it. There really isn't any other way currently.
Scott Dorman Microsoft® MVP - Visual C# | MCPD
President - Tampa Bay IASA
Hey, hey, hey. Don't be mean. We don't have to be mean because, remember, no matter where you go, there you are. - Buckaroo Banzai
[ Forum Guidelines][ Articles][ Blog]
|
|
|
|
|
Thanks, Scott.
That looks pretty good. Unfortunately, it is not recognised by VS.
I must say that I am surprised that this seems to have been overlooked when the XML documentation ability was being created. It seems (to me, at any rate) to be an obvious feature to be included - much more so than the <seealso> or <include> tags.
But, I'm still hoping one you guru's out there knows a way...
Clive Pottinger
Victoria, BC
|
|
|
|
|
cpotting wrote: I must say that I am surprised that this seems to have been overlooked when the XML documentation ability was being created. It seems (to me, at any rate) to be an obvious feature to be included - much more so than the <seealso> or <include> tags.
I agree. You may want to check the Sandcastle documentation, as it may support the overloads tag.
Scott Dorman Microsoft® MVP - Visual C# | MCPD
President - Tampa Bay IASA
Hey, hey, hey. Don't be mean. We don't have to be mean because, remember, no matter where you go, there you are. - Buckaroo Banzai
[ Forum Guidelines][ Articles][ Blog]
|
|
|
|
|
I have a scenario like the following:
I have a List of objects of type Base. But these objects are really an assortment of types that inherit from Base.
A user can extend type Base by adding their own classes dynamically compiled at runtime.
Typically, I would serialize these inherited classes by adding an XmlInclude reference in class Base. However, I cannot add such a reference for a user-extended dynamically-compiled class (since I don't know what they will be).
How does one serialize such a list and still pick up the properties from the dynamically-compiled class?
Thanks in advance for your help! I'm stuck without it!
|
|
|
|
|
Good Day,
I want to add a simple Windows context menu by adding entries to the registry See here http://www.codeproject.com/KB/shell/SimpleContextMenu.aspx[^]
However, when selecting multiple files, it will open multiple instance of the same exe with the different files opened? What I want to accomplish is like the in WinRAR - when you select multiple files, all of them will be opened using a single winrar instance.
Is there a simple workaround for this?
Thanks!
It is said that the most complex structures built by mankind are software systems. This is not generally appreciated because most people cannot see them. Maybe that's a good thing because if we saw them as buildings, we'd deem many of them unsafe.
|
|
|
|
|
I think you'll need your app to check to see if it's already running, pass the data to the running instance if it is, then close the new instance.
Dave
|
|
|
|
|
I have already thought of that, but it will be more complicated since I need to have exe communication using WCF.
The real solution is using ContextMenuHandlers that aren't easy at all!
It is said that the most complex structures built by mankind are software systems. This is not generally appreciated because most people cannot see them. Maybe that's a good thing because if we saw them as buildings, we'd deem many of them unsafe.
|
|
|
|
|
|
Exactly what I needed! Thanks thanks thanks!
It is said that the most complex structures built by mankind are software systems. This is not generally appreciated because most people cannot see them. Maybe that's a good thing because if we saw them as buildings, we'd deem many of them unsafe.
|
|
|
|
|
Hi Everyone,
I am new to c#2.0.
can anybody help with a example and detail explanation of genercis.
Thanks and Regards,
Sekhar Reddy
|
|
|
|
|
raja baireddy,
MSDN[^]
Regards,
Gareth.
(FKA gareth111)
|
|
|
|
|
A good introduction is available on MSDN[^]. Read through that, try and actually compile/run some of the examples (so you can step through them in a debugger and watch what happens) and then, if you have more questions post them again.
Scott.
—In just two days, tomorrow will be yesterday.
—Hey, hey, hey. Don't be mean. We don't have to be mean because, remember, no matter where you go, there you are. - Buckaroo Banzai
[ Forum Guidelines] [ Articles] [ Blog]
|
|
|
|
|
i want to update the listview selected item from Exited event but everytime i got this error:
Cross-thread operation not valid: Control 'listview1' accessed from a thread other than the thread it was created on.
here is the error code :
void exited_event(object sender, EventArgs e)
{
listview1.Items[0].SubItems[0].Text = "abc";
}
any solution ?
thanks
TVMU^P[[IGIOQHG^JSH`A#@`RFJ\c^JPL>;"[,*/|+&WLEZGc`AFXc!L
%^]*IRXD#@GKCQ`R\^SF_WcHbORY87??6?N8?BcRAV\Z^&SU~%CSWQ@#2
W_AD`EPABIKRDFVS)EVLQK)JKSQXUFYK[M`UKs*$GwU#(QDXBER@CBN%
Rs0~53%eYrd8mt^7Z6]iTF+(EWfJ9zaK-i?TV.C\y<p?jxsg-b$f4ia>
--------------------------------------------------------
128 bit encrypted signature, crack if you can
|
|
|
|
|
Look at Control.Invoke and Control.InvokeRequired. You cannot change UI stuff on a non-UI thread.
|
|
|
|
|
but i can change it by timer that is also non-UI thread, but if i enable it from that event it also gave same error 
TVMU^P[[IGIOQHG^JSH`A#@`RFJ\c^JPL>;"[,*/|+&WLEZGc`AFXc!L
%^]*IRXD#@GKCQ`R\^SF_WcHbORY87??6?N8?BcRAV\Z^&SU~%CSWQ@#2
W_AD`EPABIKRDFVS)EVLQK)JKSQXUFYK[M`UKs*$GwU#(QDXBER@CBN%
Rs0~53%eYrd8mt^7Z6]iTF+(EWfJ9zaK-i?TV.C\y<p?jxsg-b$f4ia>
--------------------------------------------------------
128 bit encrypted signature, crack if you can
|
|
|
|
|
The timer Tick event runs on the UI thread.
|
|
|
|
|
oh..anyway my problem has been solved by Control.Invoke() and Control.InvokeRequired
TVMU^P[[IGIOQHG^JSH`A#@`RFJ\c^JPL>;"[,*/|+&WLEZGc`AFXc!L
%^]*IRXD#@GKCQ`R\^SF_WcHbORY87??6?N8?BcRAV\Z^&SU~%CSWQ@#2
W_AD`EPABIKRDFVS)EVLQK)JKSQXUFYK[M`UKs*$GwU#(QDXBER@CBN%
Rs0~53%eYrd8mt^7Z6]iTF+(EWfJ9zaK-i?TV.C\y<p?jxsg-b$f4ia>
--------------------------------------------------------
128 bit encrypted signature, crack if you can
|
|
|
|
|
I'm using this piece of code to dump my config settings to disk. Only problem is it seems to break on certain machines. No error gets thrown but when i try to read the file back out I get an "invalid padding" error I assume that for some reason the entire stream isn't getting written out.
Do i need to flush the stream prior to closing it? Should i save it as config.new and then overwrite the origianl veraion?
public static void EncryptToFile(string ConfigData, string FilePath)
{
FileStream fStream = File.Open(FilePath, FileMode.OpenOrCreate);
Rijndael RijndaelObject = Rijndael.Create();
ICryptoTransform encryptor = RijndaelObject.CreateEncryptor(key, IV);
CryptoStream csEncrypt = new CryptoStream(fStream, encryptor, CryptoStreamMode.Write);
StreamWriter sw = new StreamWriter(csEncrypt);
sw.WriteLine(ConfigData);
sw.Close();
csEncrypt.Close();
fStream.Close();
}
Thanks for any ideas you can give me
Russell
modified on Tuesday, June 3, 2008 10:19 AM
|
|
|
|
|
I think make a detailed log for this function.Then you can identify where the function if failed.
Sudhir Kumar
|
|
|
|
|
what do you mean by 'break' ?
TVMU^P[[IGIOQHG^JSH`A#@`RFJ\c^JPL>;"[,*/|+&WLEZGc`AFXc!L
%^]*IRXD#@GKCQ`R\^SF_WcHbORY87??6?N8?BcRAV\Z^&SU~%CSWQ@#2
W_AD`EPABIKRDFVS)EVLQK)JKSQXUFYK[M`UKs*$GwU#(QDXBER@CBN%
Rs0~53%eYrd8mt^7Z6]iTF+(EWfJ9zaK-i?TV.C\y<p?jxsg-b$f4ia>
--------------------------------------------------------
128 bit encrypted signature, crack if you can
|
|
|
|
|
The safest way to do this would be to save it as a new file and then overwrite the original. You also want to wrap the streams in a using statement to ensure that they get disposed of properly. Finally, you want to add some try...catch handling.
Scott.
—In just two days, tomorrow will be yesterday.
—Hey, hey, hey. Don't be mean. We don't have to be mean because, remember, no matter where you go, there you are. - Buckaroo Banzai
[ Forum Guidelines] [ Articles] [ Blog]
|
|
|
|
General 
News 
Suggestion 
Question 
Bug 
Answer 
Joke 
Praise 
Rant 
Admin 
Submit an article or tip
