[ 
https://issues.apache.org/jira/browse/PDFBOX-2576?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14279536#comment-14279536
 ] 

John Hewson edited comment on PDFBOX-2576 at 1/15/15 11:48 PM:
---------------------------------------------------------------

Removing the "throws" is good, but don't remove the JavaDoc - that not improve 
the code quality, because it fails to document the behaviour of our API. I 
refer you to _Effective Java_ - "Item 62: Document all exceptions thrown by 
each method".


was (Author: jahewson):
This does not improve the code quality, because it fails to document the 
behaviour of our API. I refer you to _Effective Java_ - "Item 62: Document all 
exceptions thrown by each method" which is the code quality bible for Java.

> Improve code quality
> --------------------
>
>                 Key: PDFBOX-2576
>                 URL: https://issues.apache.org/jira/browse/PDFBOX-2576
>             Project: PDFBox
>          Issue Type: Task
>    Affects Versions: 2.0.0
>            Reporter: Tilman Hausherr
>
> This is a longterm issue for the task to improve code quality, by using the 
> [SonarQube 
> report|https://analysis.apache.org/dashboard/index/org.apache.pdfbox:pdfbox-reactor],
>  hints in different IDEs, the FindBugs tool and other code quality tools.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to