> Am 19.03.2015 um 18:37 schrieb Tilman Hausherr <[email protected]>: > > John once mentioned that "Returns xxx" is legit according to an Oracle java > style guide. My own IDE (which is developed by Oracle) brings out a warning. > > http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#@return >
I think he mentioned Googles style guide http://google-styleguide.googlecode.com/svn/trunk/javaguide.html#s7.3.1-javadoc-exception-self-explanatory <http://google-styleguide.googlecode.com/svn/trunk/javaguide.html#s7.3.1-javadoc-exception-self-explanatory> if I remember correctly. > Tilman > > Am 19.03.2015 um 10:49 schrieb Maruan Sahyoun: >> I'm about to start to enhance the documentation for PDFBox 2.0.0 with the >> initial step to enhance the javadoc files (also covering xmpbox, preflight, >> fontbox). >> >> Currently we have a rule - at least in Checkstyle - that a method returning >> a non-void type should have a @return tag. That's not always the case and >> leads to violations of the rule. So shall we either >> >> - disable the rule >> - or mandate it >> >> I'd go for mandating it as this will allow to tell that even for simple >> methods if they are really so or if there is additional complexity. >> >> Good sample IMHO for a JavaDoc coding style >> https://www.liferay.com/de/community/wiki/-/wiki/Main/Javadoc+Guidelines#section-Javadoc+Guidelines-Method+Javadoc+Tags >> >> >> BR >> Maruan >> >> >> >> --------------------------------------------------------------------- >> To unsubscribe, e-mail: [email protected] >> For additional commands, e-mail: [email protected] >> > > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] >
