Commenting the code

All applications need some kind of code commenting mechanism for maintenance purposes. With programming languages it is easier; however, with tools it can be a little tricky to put comments. In this recipe, we will see different options around putting comments within a report that will be invisible for users but accessible to the developers.

Getting ready

Open any existing report in IBM Cognos Report Studio.

How to do it...

In this recipe we will see some techniques that you can use to insert comments to your reports.

1. For the first technique to put comments and notes within a report and hide them from users, go to Page Explorer and create a new page. Call it Comments.

2. Open this new page and drag text items onto it. Write all comments about the report here (description, functionality, notes, special cases, and so on).

3. Now go to Condition Explorer and create a new Boolean variable. Define the expression as: 1=0. Name this variable as Render_Comments.

4. Go to the Comments page. Open...