Documenting Exceptions

home
c#
view story

3 Kicks

Documenting Exceptions(www.blackwasp.co.uk)

submitted by BlackWasp(4212) 3 months, 10 days ago

Code can be decorated with XML documentation comments, which can be compiled into documentation files. When members can throw exceptions, the comments can include a description of each expected exception and the reasons why it may be thrown.

2 comments |category: C# |Views: 122
Tweet

tags: C# another

Everyones tags:

Your Tags:

Please login or signup.

Add a live kick counter to your blog >> liveImage

You can even customize the image by choosing your own colors, and then clicking the button below to update the preview and the html code:

"Kick It" text
"Kick It" background
kick count text
kick count background
border

Simply copy and paste this HTML into your blog post.

Users who kicked this story:

pwhe23(972) -

dpeterson(4397) -

BlackWasp(4212)

Comments:

posted by dpeterson(4397) 3 months, 9 days ago 0

I really wish more open source projects would take advantage of not only XML generated documentation, but specifically documenting the types of exceptions the code may throw. I've had issues where after weeks in production an app will suddenly receive a fatal exception for something as simple as the network connection being interrupted. Had I known the developer was going to throw an exception in that situation I would have tried to trap it locally and allow the program a chance to recover, rather than going through a failsafe procedure and closing.

posted by BlackWasp(4212) 3 months, 9 days ago 0

I know that feeling :)

Most Active Users

What's this?