se-edu / addressbook-level4 / 4764
93%
master: 94%

LAST BUILD BRANCH: 453-result-message
DEFAULT BRANCH: master
Ran
Jobs 1
Files 90
Run time 6s
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
4764

Pull #934

travis-ci

web-flow 
checkstyle: allow missing javadoc for private methods

Javadocs allow readers to understand the behavior/specification of a
method, without needing to look at the source code of the method itself.
However, they also present an additional maintenance cost as they need
to be kept up to date.

In the case of private methods, javadocs don't really present any
advantages, as since the methods are _private_, users have to view the
source code of the method in order to read its javadoc anyway.

Furthermore, private methods are usually used as auxiliary/utility
functions for algorithms, where full understanding can't be gained from
just reading the javadoc, since it is highly coupled to the details of
the full algorithm and hence the reader would need to read the source
code of the whole file anyway.

Additionally, in the case of utility functions, in line comments usually
do a much better job of telling what the reader what is going on (by
interspersing code with some light explanations), rather than javadocs
and their huge block of prose.

Some examples in the code base where enforcing javadocs on private
methods don't really add much value include the
assertCommandSuccess()/assertCommandFailure() private methods in
AddCommandSystemTest, DeleteCommandSystemTest etc. where the javadocs
are simply a description of their source code in prose.

Let's relax the checkstyle configuration to allow private methods with a
missing javadoc.

This doesn't mean that _all_ private methods shouldn't have javadocs --
if developers feel that they can add value on a case-by-case basis, then
that's fine.
Pull Request #934: checkstyle: allow missing javadoc for private methods

1433 of 1544 relevant lines covered (92.81%)

0.93 hits per line

Jobs
ID Job ID Ran Files Coverage
1 4764.1 0
92.81
 Travis Job 4764.1
Source Files on build 4764
Detailed source file information is not available for this build.