The page I am working on has a javascript function executed to print parts of the page. For some reason, printing in Safari, causes the window to somehow update. I say somehow, because it does not really refresh as in reload the page, but rather it starts the "rendering" of the page from start, i.e. scroll to top, flash animations start from 0, and so forth. The effect is reproduced by this fiddle: http://jsfiddle.net/fYmnB/ Clicking the print button and finishing or cancelling a print in Safari causes the screen to "go white" for a sec, which in my real website manifests itself as something "like" a reload. While running print button with, let's say, Firefox, just opens and closes the print dialogue without affecting the fiddle page in any way. Is there something with my way of calling the browsers print method that causes this, or how can it be explained - and preferably, avoided? P.S.: On my real site the same occurs with Chrome. In the ex
I assume you're talking about docblocks.
ReplyDeleteIf 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.