[CONF] Apache Qpid > AMQP 1.0 JMS Client Coding Standards

[confluence]

AMQP 1.0 JMS Client Coding Standards Page added by Phil Harvey This page is essentially a proposal, created to help us reach consensus on specific standards that apply to the JMS client work. Our main coding standards are at Java Coding Standards. The AMQP 1.0 JMS Client project mandates the following additional standards. Overriding methods from java.lang.Object Logging Commenting incomplete code (TODO etc) Overriding methods from java.lang.Object toString() implementations should use org.apache.commons.lang.builder.ToStringBuilder with its SHORT_PREFIX_STYLE, for example: @Override public String toString() { return new ToStringBuilder(this, ToStringStyle.SHORT_PREFIX_STYLE) .append("sendMessage", _sentMessage) .append("sender", _sender) .toString(); } equals(Object) should be implemented using org.apache.commons.lang.builder.EqualsBuilder hashCode() should be implemented using org.apache.commons.lang.builder.HashCodeBuilder Logging SLF4J must be used for logging. Logger names should be based on the class name, e.g. private static final Logger _logger = LoggerFactory.getLogger(Main.class); Logger names may use unconventional values in specialised cases, e.g. auditing or timing. Commenting incomplete code (TODO etc) 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: When modification must happen Comment marker Before committing to SVN // TODO-SVN Before the next release // TODO-RELEASE At an unspecified time // TODO Change Notification Preferences View Online | Add Comment --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org