Leave a comment

Understanding Comments in IBM i
Leaving comments in code is a crucial practice for maintaining clarity and facilitating collaboration among developers. In IBM i environments, comments can be added in various programming languages such as RPG, CL, and SQL.

• RPG Comments: In RPG, comments can be added using the *INCLUDE statement or by using the // syntax for inline comments.
• CL Comments: In CL, comments are typically prefixed with the ‘/*’ and ‘*/’ for block comments or ‘//’ for single-line comments.
• SQL Comments: SQL supports comments using ‘--’ for single-line comments and ‘/* ... */’ for multi-line comments.

Effective commenting not only aids in code readability but also serves as documentation for future reference. It is essential to strike a balance between providing enough information and avoiding clutter. Developers should aim to explain the 'why' behind complex logic rather than restating the 'what' that is already evident from the code itself. Additionally, adhering to a consistent commenting style across the codebase can enhance collaboration and reduce onboarding time for new team members. In conclusion, leaving thoughtful comments in IBM i programming is a best practice that contributes to the longevity and maintainability of applications.