Edit Question - KnowledgeHub

Title Body

This is not a biggie at all, but something that would be very helpful indeed if resolved. When I'm overloading methods etc there are times when the xml comments are exactly the same, bar 1 or 2 param names. I have to copy/paste the comments down to each overloaded method, where they are the same. Sometimes, however, this can cause misleading information about the method if I update one of them and forget to go back and copy/paste them to all others. If there are alot of overloaded methods, this can be very time consuming and prone to error. So I'm wondering if there is a way of storing comments in one place (like a variable), which I can simply reference instead. This way, one change will be reflected across all related commetns. Here's an example: /// <summary> /// Go and do something /// </summary> public void DoSomething() { DoSomething(true, "Done something"); } /// <summary> /// Go and do something /// </summary> /// <param name="doIt">whether it should be done or not</param> public void DoSomething(bool doIt) { DoSomething(doIt, "Done something"); } /// <summary> /// Go and do something cool /// </summary> /// <param name="doIt">whether it should be done or not</param> /// <param name="doneMessage">message to show once done</param> public void DoSomething(bool doIt, string doneMessage) { if (doIt) Console.WriteLine(doneMessage); } So as you can see, all of the comments are the same except I decided to make a correction on the last one to read 'Go and do something cool'. Now i'll have to go and change this is all the other method comments too. Cheers.

Tags (comma-separated) Cancel