Inserting Header Comments

Header comments represent descriptive comments that can be placed at the top of a code module or above the first line of a method.

CodeSMART uses two types of header comments:

• Module headers represent descriptive comments that are placed at the top of code modules' declaration area.
• Procedure (member) headers are descriptive comments that are inserted above the first line procedures, functions and property procedures.

To insert header comments for a single component or member:

1. If you want to insert a module descriptive header then open the corresponding component's code pane click the right mouse button in the component's declaration area.
   If you want to add a procedure header click the right mouse button in the respective member's code.
2. Select Insert Descriptive Header from the code window shortcut menu. Please use Control Panel dialog box (then Interface/ Toolbars/ Code Window Popup Menu Entries) in order to add the Insert Descriptive Header option to the code window shortcut menu - this entry isn't present by default on code window menu.
   
   If the component or member had a previously inserted header comment then CodeSMART will ask if you want to overwrite it. By choosing Yes a new header will replace the existing one.
   
   The inserted header comment's code is determined by the currently active template for the corresponding category in the Comment Templates Manager.

To insert header comments for multiple components:

1. Click Insert Module Header in the Comments pull down menu found on the Code Edit Tools toolbar, or select the same entry in the CodeSMART main menu (quick toolbar and menu references are available). in order to display the Insert Module Header dialog box.

   

2. Select the operation scope. Depending on the current position in code and the active code or designer window, only valid options are listed.
3. Specify if you want CodeSMART to remove previously inserted headers when inserting the new ones. If you don't check this option then the components that already have descriptive headers will be skipped.
4. Press Begin to start the operation. Depending on the situation, a progress bar may appear to reflect the operation progress.

To insert header comments for multiple members:

1. Click Insert Procedure Header in the Comments pull down menu found on the Code Edit Tools toolbar, or select the same entry in the CodeSMART main menu in order to display the Insert Procedure Header dialog.

   

2. Select the operation scope. Depending on the current position in code and the active code or designer window, only valid options are listed.
3. Specify if you want CodeSMART to remove previously inserted headers when inserting the new ones. If you don't check this option then the members that already have descriptive headers will be skipped.
4. Choose between the two possible insertion points.
5. Press Begin to start the operation. Depending on the situation, a progress bar may appear to reflect the operation progress.

 Note

• For a property procedure with multiple instances (e.g. Let and Get) a descriptive header will be inserted for each individual instance.

See Also

Back To Top