Skip to main content

Comments

The most important of all of the Java standards for readability are the comment standards. ALL code should be well documented. It must not be assumed that another developer will be able to interpret the code.

Some people are better at coding than others and as the Talend ESB tool is not a coding tool exclusively it is important to make sure that everyone has a chance of being able to work out what it happening.

All classes and methods should have Javadoc style comments (http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html) and inline comments should be used where appropriate.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!