Re: Problems Handling Errors Correctly
- From: "Jonathan Wood" <jwood@xxxxxxxxxxxxxxxx>
- Date: Sun, 16 Sep 2007 22:04:54 -0600
Doug,
The class documentation is (mostly) generated from code comments - I don't remember the web site off hand but Google "SandCastle help generator" and you'll find a utility that turns the xml file generated from the code comments into MSDN style documentation (it is a public version of Microsoft's tool they use to generate alot of the class documentation)
Aha! Pretty much what I expected. Since /// <summary> isn't the easiest place to edit text, that really makes a lot of sense to me. Will check out that generator too.
It's pretty complete (exception documentation, that is) in my experience. Every once in a while you'll get an exception that's thrown from deep in the stack that doesn't seem intuitve, but for me it's usually when I'm dealing with remoting or xml stuff. I would think that requiring any framework the size of .NET to document all possible Exceptions that could be thrown from calls to subfunctions is next to impossible (and I think MSDN's documentation had even stated in the past at least that the <exception> doc tag should document excpetions thrown directly from the function itself and not those from sub functions.
Yeah, the bottom line is that I don't particularly care for try...catch exceptions. It gets to where you put try...catch in every routine if you want to ensure you're program will never crash with an unhandled exception.
Jonathan
.
- Follow-Ups:
- Re: Problems Handling Errors Correctly
- From: Doug Semler
- Re: Problems Handling Errors Correctly
- From: Peter Duniho
- Re: Problems Handling Errors Correctly
- References:
- Problems Handling Errors Correctly
- From: Jonathan Wood
- Re: Problems Handling Errors Correctly
- From: Peter Duniho
- Re: Problems Handling Errors Correctly
- From: Jonathan Wood
- Re: Problems Handling Errors Correctly
- From: Peter Duniho
- Re: Problems Handling Errors Correctly
- From: Jonathan Wood
- Re: Problems Handling Errors Correctly
- From: Peter Duniho
- Re: Problems Handling Errors Correctly
- From: Jonathan Wood
- Re: Problems Handling Errors Correctly
- From: Peter Duniho
- Re: Problems Handling Errors Correctly
- From: Jonathan Wood
- Re: Problems Handling Errors Correctly
- From: Peter Duniho
- Re: Problems Handling Errors Correctly
- From: Jonathan Wood
- Re: Problems Handling Errors Correctly
- From: Doug Semler
- Problems Handling Errors Correctly
- Prev by Date: how to release the memory allocated by 'gcnew'
- Next by Date: Re: Create ImageButton Dynamiclly
- Previous by thread: Re: Problems Handling Errors Correctly
- Next by thread: Re: Problems Handling Errors Correctly
- Index(es):