2

In C#, it is good practice to add XML documentation to describe any exceptions that a method can throw. It is not difficult to add these for exceptions that you throw yourself. However, if I'm calling another method, and I've decided not to handle an exception thrown by this second method, there's no point in me re-writing existing documentation. I need to find the documentation for this second method and copy & paste it into the documentation for my method. Worse still are Framework methods, where I find myself copy & pasting little chunks of text from MSDN into my documentation.

Are there any tools that can automate this process? I'm thinking that there must be a plugin for VS that allows you to right-click a called method and select something like "Add Exception documentation to calling method documentation". Any suggestions would be helpful.

Improve this question
1
  • And what if the underlying library changes? Or the library that the underlying library depends on and so forth? Are you going to repeat this process on every update? Checked exceptions were left out from C# for a reason. Commented Jan 15, 2009 at 1:02

1 Answer 1

Reset to default
2

This sounds like a feature request for ghostdoc. It doesn't do this, but it does help with copying documentation when overriding a method or implementing an interface.

That being said, such a feature would have only limited usefulness because C# does not have checked exceptions like Java.

Improve this answer
Sign up to request clarification or add additional context in comments.

1 Comment

+1 but I disagree about checked exceptions - knowing what kind of exceptions may be thrown is helpful documentation even if you do not have checked exceptions.

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge you have read our privacy policy.

Start asking to get answers

Find the answer to your question by asking.

Ask question

Explore related questions

See similar questions with these tags.