Annotations

Annotations are special comments in the documents. They differ from regular comments by the following things:

the information is collected by Quanta and shown in the Annotations toolview.
the information can be addressed to a team member

Entering annotations is simple. You can either use the Annotate entry from the editor context menu or enter the @annotation keyword in a comment area followed by the annotation text.

Example 6.1. Annotation example in XML

<!-- @annotation It is possible  that this code is wrong. -->

<!-- @annotation
 Multiline 
 annotation. 
-->

Example 6.2. Annotation example in PHP

/* @annotation 
Use PHP comments when annotating a PHP area
*/

Annotations can be addressed for a specific member of your team. The syntax in this case is @annotation(nickname) or @annotation(role), where nickname is the nickname of a team member, while role is a project role from the following items:

team leader
task leader
subproject leader

The task and subproject leaders should be followed by the corresponding task and subproject name, like it is shown in the below examples.

Example 6.3. Make a note to a team member with the nickname eric

<-- @annotation(eric) Eric, please look at this. Andras -->

Example 6.4. Inform the team leader

<-- @annotation(team leader) This is very important for the team -->

Example 6.5. Inform the PHP subproject leader

// @annotation(subproject leader:PHP) What do you think about it?

Nicknames and role names are case insensitive, but spaces around brackets and the : make the annotation invalid.

More about team members, roles and nicknames can be found in the section called “Team Development”.

The annotations found in the project can be inspected in the Annotations view. It consists of tree tabs:

Current File: The annotation found in the current file.
For You: Annotations in the project addressed for you. The entries are groupped per file.
All Files: The annotations found in all the project files, groupe dy files

The annotations are scanned on project and file load for external modifications. This way even is somebody adds an annotation outside of Quanta Plus, it will be recognized. As scanning can take some time, the information dialog about new annotations addressed for you might appear after some seconds of the project loading.