Link

Predlab Guide rev. 2020.5.19.4

Search

Contents

Table of contents

  1. Concepts
  2. Create Annotation
  3. Edit Annotation
    1. On IDE
    2. On Predlab Web Console
  4. Delete Annotations
    1. On IDE
    2. On Predlab Web Console
  5. Annotation tree
  6. Where To Go from Here?

Concepts

  • CodeFlags are the annotations that you add to a piece of code within your project.
  • They are synchronized with the team members you add to your workspace.
  • They are attached to your code via “code anchors”.
  • They can be edited from the editor and the web console.

Annotations can contain any Markdown-supported content.

Create Annotation

To annotate a code snippet:

  1. Select the lines that you want to annotate
  2. right-click and select “set code flag” from the context menu
  3. In the code flag editor that appears, add your annotation content
  4. Click “insert”

You can now see your newly added codeflag next to the code you selected!

Note

When add an annotation to a code snippet, Predlab adds a “code anchor” comment above that snippet. As the name suggests, that comments helps the plugin locate the code snippet location when that file is edited.


/*
@codeFlag[aGsRfG2aNDpWAL6yGihGYp]
 */

Edit Annotation

You and your workspace team mates can edit the annotations. The annotations can be edited from the editor, and from the Predlab Web Console.

On IDE

To edit an annotation from the IDE

  1. click on the “pen” icon on the top-left of a flag, then choose edit.
  2. Edit the content
  3. click save

On Predlab Web Console

To edit an annotation from your web console

  1. Login to your Predlab Console
  2. Find the annotation you want to edit
  3. Edit the content
  4. click save

Delete Annotations

On IDE

To delete an annotation from the IDE click on the “pen” icon on the top-left of a flag, then choose delete.

Predlab Sync Project Flag tree

On Predlab Web Console

To delete an annotation from your web console

  1. Login to your Predlab Console
  2. Under the “Codeflags” section, find the annotation you want to delete

Predlab Sync Project Flag tree

Annotation tree

Predlab generates a file tree with all the files that contain annotations (codeflags).

You can jump to a code flag by clicking on the file’s name in the tree. Predlab Sync Project Flag tree

Where To Go from Here?

Check out how to manage your workspace contributors.