Documenting a Macro: Adding Comments

Just as it's useful to document any program, it's useful to document what you're trying to do in a macro. You or others can use these comments when modifying a macro later. Because macro comments print when you print the macro, you can also use macro comments as documentation.

To add a comment to a macro, click the Comment column of the macro and begin to type. Figure 13.16 shows macros with comments. As you can see in Figure 13.17, these comments appear in the printed macro.

Figure 13.16. Adding comments to a macro.


Figure 13.17. Comments included in a printed macro.



You can add comments to a macro action by placing FALSE in the Condition column of the macro line for which you're creating a comment. This is useful when you're testing or debugging a macro.

    Part III: Creating Your Own Database and Objects
    Part V: Advanced Topics