How to document exceptions?

Question

Often methods in VB.Net throw exceptions. How can I write the code or documentary comments to allow possible exception throws to pop-up when the method is used in code? (Like the way a method's summary pops up.)

The point is to show the testers or other users of the method what exception(s) to expect.

What do you mean? Yes, you can throw exceptions using the command Throw New Exception(Message). — Nizam
– Nizam, Commented Feb 4, 2014 at 12:56
As I read in C# there is a way to document an exception that custom method throws /// <summary>the method's summary</summary> /// <exception cref="ArgumentNullException">some comment</exception> But I am afraid that does not work in vb. — Kalin Krastev
– Kalin Krastev, Commented Feb 4, 2014 at 13:04
Can you post the C# code? have you tried the C# to VB converters that are online? e.g. converter.telerik.com — Mych
– Mych, Commented Feb 4, 2014 at 14:00
Thanks, Mych. I tried [link](C# XML documentation) As I mentioned it is weird but it seems exception tags doesn't work for VB.Net — Kalin Krastev
– Kalin Krastev, Commented Feb 4, 2014 at 14:12

sloth · Accepted Answer · 2014-02-04 13:05:22Z

3

You can use the <exception> tag in the XML documentation of a method.

answered Feb 4, 2014 at 13:05

sloth

101k21 gold badges182 silver badges224 bronze badges

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

2 Comments

Kalin Krastev Over a year ago

Thanks, @Dominic Kexel, but I am afraid I tried the XML documentation and the exception doesn't pop-up. Trying the same in C# results in showing the exception below the summary in a pop-up when method is used in code. But in VB only summary is showed but not and the exceptions thrown.

sloth Over a year ago

Sorry, but Intellisence in VB.Net won't show you the exceptions like it does in C#. But you should still use the <exception> tag since the Object Browser does read this tag and show you the exceptions; so this information is just one keypress away.

Collectives™ on Stack Overflow

How to document exceptions?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related