Inserting annotations requires you to reference the annotation definitions include file as well as
include
it from each source file that contains Intel Advisor XE
annotations.
Note
For this beta, use of the Annotation Wizard is only supported in the Visual Studio code editor - see the Release Notes.
Use the annotation wizard to insert Intel Advisor XE
annotations to your program.
- In the editor defined by the $EDITOR environment variable, select the code section that you wish to annotate.
- Right-click to open the context menu and select Intel Advisor XE 2013> Annotation Wizard... The Annotation Wizard opens with the default Annotate Site annotation selected.
- From the Choose the Annotation Type drop-down, choose the appropriate annotation type. Your code appears in the Example section of the dialog, with the annotation line(s) highlighted in red font.
- Click Next to configure the parameters of the opening annotation line. For Annotation types that include parameters, page 2 of the wizard appears. For Annotation types that do not include parameters, go to step 8.
- Specify the parameter values for the first parameter in the Annotation type, or use the default text that appears in the wizard. The highlighted annotation line now has your specified parameter value entered in the annotation line.
- Click Next to configure, or keep the default text for the next parameter. Repeat for all the parameters. The highlighted annotation line now has all parameters filled in with values entered in the annotation line.
- Click Next to go to page 3 of the wizard and review the annotation line before adding it to you code.
- Click Finish to insert the annotation line with your specified parameters to your code. The Wizard closes and the editor shows the annotation lines added to the code.
The annotation line(s) are inserted in the editor.
If a loop only executes a single statement and does not contain an opening brace ({) to allow multi-statement execution, insert braces ({ and }) around the existing statement and the inserted annotation.
Adding an Annotation for a Parallel Site
The following screen capture shows the C/C++ annotation lines for an annotation of type Annotate Site, with the site name parameter defined as: queens:
