[
https://issues.apache.org/jira/browse/PDFBOX-2672?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14311242#comment-14311242
]
Andrea Vacondio commented on PDFBOX-2672:
-----------------------------------------
My 2 cents:
* Give variables and methods meaningful names
* Minimize the API (don't make everything public just because you can)
* _Non trivial_ public and protected methods and fields must have JavaDoc
(JavaDoc for a setSomething that states "set the something" is just useless
noise)
* Public and protected methods -and fields- must have JavaDoc
* Instance fields *must* be private and encapsulated
* Prefer multiple short methods to a long and complicated ones (break it and
make it readable)
Also I just notices that the mentioned page says:
??Eclipse users may download this preferences file: pdfbox-checkstyle-5.xml and
import this into Eclipse. (Window->Preferences, go to Java->Code
Style->Formatter and click "Import...").??
but it's the _pdfbox-eclipse-formatter.xml_ that should be imported, not the
checkstyle config file.
> Wrong code convention link on the website
> -----------------------------------------
>
> Key: PDFBOX-2672
> URL: https://issues.apache.org/jira/browse/PDFBOX-2672
> Project: PDFBox
> Issue Type: Bug
> Components: Documentation
> Reporter: Andrea Vacondio
> Priority: Trivial
>
> Currently the website page https://pdfbox.apache.org/codingconventions.html
> points to the Sun's code convention -> http://java.sun.com/docs/codeconv but
> that page doesn't exist anymore.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
