commons-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Thomas Neidhart (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MATH-852) Improvements to the Developer's Guide
Date Tue, 18 Sep 2012 11:36:09 GMT

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

Thomas Neidhart commented on MATH-852:
--------------------------------------

If the goal is to have proper formatted XHTML, than I am fine with this, and we should have
</p> tags as well.

@punctuation: I like the approach in the javadoc tutorial, that one line fragments are not
ended with a period whereas if there is an additional description, they are separated by a
period and the final sentence also ends with a period. Keep in mind that most @param descriptions
are not really sentences:

{noformat}
 * @param text1  the text of the tool tip
 * @param text1  the string to display.  If the text is null, 
 *               the tool tip is turned off for this component.
{noformat}

@indentation: the rule is actually quite simply and derived from the need to have readable
javadoc in your IDE (in the browser it does not matter, as the javadoc tool formats it for
you). When there are lots of @param, @throws and a @return tag with long descriptions this
can easily lead to a wall of text that is very difficult to read. The indentation is there
to easily separate the different tags with your eye. Whether you use 2 or more spaces depends
what you prefer (I think the default formatter in eclipse puts a fixed indentation at position
19/20).
                
> Improvements to the Developer's Guide
> -------------------------------------
>
>                 Key: MATH-852
>                 URL: https://issues.apache.org/jira/browse/MATH-852
>             Project: Commons Math
>          Issue Type: Improvement
>            Reporter: S├ębastien Brisard
>              Labels: formatting, guidelines
>
> Recent discussions (see MATH-851, as well as these threads [1|http://markmail.org/thread/utxuipyolpnche5o],
[2|http://markmail.org/thread/sma3nwa5j3hspvp5]) have shown that our actual requirements (especially
regarding formatting) are higher than stated in the Developer's Guide. This leads to confusion
among new contributors, as well as recent committers. It is therefore proposed to revise this
guide, in order for it to reflect the actual expectations regarding submitted code.
> This guide should however not act as a deterrent for new contributors, so attention should
be paid to "rules" we consider as essential vs. superfluous rules.
> Here is an extract of the developer's guide in its current state
> h3. Coding Style
> Commons Math follows [Code Conventions for the Java Programming Language|http://www.oracle.com/technetwork/java/codeconv-138413.html].
As part of the maven build process, style checking is performed using the Checkstyle plugin,
using the properties specified in checkstyle.xml. Committed code should generate no Checkstyle
errors. One thing that Checkstyle will complain about is tabs included in the source code.
Please make sure to set your IDE or editor to use spaces instead of tabs.
> Committers should make sure that svn properties are correctly set on files added to the
repository. See the section on Committer Subversion Access on the Apache Source Code Repositories
page.
> h3. Documentation
> * Committed code must include full javadoc.
> * All component contracts must be fully specified in the javadoc class, interface or
method comments, including specification of acceptable ranges of values, exceptions or special
return values.
> * External references or full statements of definitions for all mathematical terms used
in component documentation must be provided.
> * Implementations should use standard algorithms and references or full descriptions
of all algorithms should be provided.
> * Additions and enhancements should include updates to the User Guide.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message