qpid-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Qpid > AMQP 1.0 JMS Client Coding Standards DELETED
Date Wed, 05 Jun 2013 15:57:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/21/_/styles/combined.css?spaceKey=qpid&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/qpid/AMQP+1.0+JMS+Client+Coding+Standards+DELETED">AMQP
1.0 JMS Client Coding Standards DELETED</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~phil@philharveyonline.com">Phil
Harvey</a>
    </h4>
        <br/>
                         <h4>Changes (2)</h4>
                                 
    
<div id="page-diffs">
                    <table class="diff" cellpadding="0" cellspacing="0">
    
            <tr><td class="diff-deleted-lines" style="color:#999;background-color:#fdd;text-decoration:line-through;">{info}
<br>This page is essentially a proposal, created to help us reach consensus on specific
standards that apply to the JMS client work. <br>{info} <br> <br>Our main
coding standards are at [qpid:Java Coding Standards]. <br> <br>The AMQP 1.0 JMS
Client project mandates the following additional standards. <br> <br>{toc} <br>
<br>h4. Overriding methods from java.lang.Object <br> <br>* *toString()*
implementations should use org.apache.commons.lang.builder.*ToStringBuilder* with its *SHORT_PREFIX_STYLE*,
for example: <br>{code} <br>    @Override <br>    public String toString()
<br>    { <br>        return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE)
<br>            .append(&quot;sendMessage&quot;, _sentMessage) <br>  
         .append(&quot;sender&quot;, _sender) <br>            .toString(); <br>
   } <br>{code} <br> <br>* *equals(Object)* should be implemented using
org.apache.commons.lang.builder.EqualsBuilder <br>* *hashCode()* should be implemented
using org.apache.commons.lang.builder.HashCodeBuilder <br> <br>h4. Logging <br>*
SLF4J must be used for logging. <br>* Logger names should be based on the class name,
e.g. {code}private static final Logger _logger = LoggerFactory.getLogger(Main.class);{code}
<br>** Logger names may use unconventional values in specialised cases, e.g. auditing
or timing.  <br> <br>h4. Commenting incomplete code (TODO etc) <br>Sometimes
code needs to be commented to indicate that future modification is intended. The comment marker
to use depends on when that modification should happen: <br>||When remediation must
happen||Comment marker|| <br>|Before committing to SVN| {code}// TODO-SVN{code}| <br>|Before
the next release| {code}// TODO-RELEASE{code}| <br>|At an unspecified time| {code}//
TODO{code}| <br> <br>The intention of this standard is to help distinguish between
the different types of &quot;TODO&quot; comment, e.g. to avoid committing code to
SVN that was only added for local debugging purposes. <br>Note that Java IDEs such as
Eclipse can be configured to recognise custom markers and assign them specific priorities.
<br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">This
page has been removed because all of its suggestions were discussed and rejected. I (Phil)
do not have permission to actually delete wiki pages so this skeleton remains. <br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <p>This page has been removed because all of its suggestions were discussed
and rejected. I (Phil) do not have permission to actually delete wiki pages so this skeleton
remains.</p>
    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/qpid/AMQP+1.0+JMS+Client+Coding+Standards+DELETED">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=31823828&revisedVersion=3&originalVersion=2">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/qpid/AMQP+1.0+JMS+Client+Coding+Standards+DELETED?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org


Mime
View raw message