Skip to main content

@throws tag with exception's parent class name



Sometimes it is impossible to know really thrown exception class name in advance, only in run-time (at least in php). So is it correct to put in @throws tag the parent class of really thrown exception?




Comments

  1. I assume you're talking about docblocks.

    If it's "impossible" for you to determine ahead of time what exceptions might be thrown you should consider refactoring. Methods and functions should deal with discrete blocks of functionality that perform specific, testable actions.

    Tag your methods with @throws when you've specifically designed them to throw an exception or they invoke other methods that are capable of throwing exceptions. Anything else is an extraordinary condition that shouldn't be documented ahead of time. Although your exceptions will extend the base Exception class, it does you no good to add @throws Exception to every function or method in your code.

    So an example: say you're using a custom error handler (using set_error_handlerdocs) to throw an ErrorExceptiondocs on the occurrence of any PHP error. You know the getMyInclude function below is capable of throwing an exception because include will raise an E_WARNING if $file can't be included, so you document that. The getIt function, however, is not capable of throwing an exception so you don't use a @throws line:

    <?php

    /**
    * Includes user specified files
    *
    * @throws ErrorException On failure to include file
    */
    function getMyInclude($file)
    {
    // include
    include $file;
    }

    /**
    * Returns the specified argument
    */
    function getIt($x)
    {
    return $x;
    }

    ?>


    Obviously you wouldn't have real-world code like getIt in the above snippet, but you also know it can't throw an exception.

    ReplyDelete

Post a Comment

Popular posts from this blog

Slow Android emulator

I have a 2.67 GHz Celeron processor, 1.21 GB of RAM on a x86 Windows XP Professional machine. My understanding is that the Android emulator should start fairly quickly on such a machine, but for me it does not. I have followed all instructions in setting up the IDE, SDKs, JDKs and such and have had some success in staring the emulator quickly but is very particulary. How can I, if possible, fix this problem?

Java Urban Myths

Along the line of C++ Urban Myths and Perl Myths : What are the Java Urban Myths? That is, the ideas and conceptions about Java that are common but have no actual roots in reality . As a Java programmer, what ideas held by your fellow Java programmers have you had to disprove so often that you've come to believe they all learned at the feet of the same drunk old story-teller? Ideally, you would express these myths in a single sentence, and include an explanation of why they are false.