Parent page: System & Environment Panels
The Comments panel allows you to add comments to a defined area or point in the active document of a managed project. The panel allows all users who are working on the document to add comments and view all comments without actually modifying the document itself. This feature allows facilitation of strong collaboration processes and is invaluable when issues within the document need to be pointed out without receiving conflicts. The Comments panel essentially can be used to create a 'to do' list and as the design matures. the comments can be resolved and closed.
The panel is accessed from a managed project by performing one of the following then clicking in the document to define the point or area for the comment:
You can configure which comments are displayed in the panel as well as specify whether or not to display the comments on the schematic or PCB by clicking the at the top right of the panel.
Use the Context region to switch between Project (view all comments across all source documents in the project) and Document (view all comments for the active document).
Use the Comments region to view either Active or Resolved comments. Comments that have been resolved will display a green bar as shown below in the image on the right.
To add a new comment, type the desired comment in the text box then click the Post button. The comment will be committed and appear in the panel. It will appear in the workspace linked to the point, area, or component by a dashed reference line.
To edit a placed comment, click the Edit button associated with the comment you want to change then enter your edits in the text box. Click Update when you are done editing.
To resolve (close out) a comment, select the comment to highlight it then click the Reply button and choose Resolve entry. The comment will be removed from the panel and the workspace.
To view Resolved comments, click the control at the top right of the panel and switch to Resolved in the Comments region. You can resurrect comments that have been resolved by clicking the Reopen button associated with a resolved comment. The comment will be reinstated in the panel and in the workspace.
To delete a comment, click the Delete button associated with that comment.
An avatar can be added for a user, as well as the user's name. These are sourced directly from the user's profile in the Server.
You can collapse a comment in the workspace by clicking on the small triangle at the top-left of the text area.
When using the Freehand comment feature (Place » Freehand comment, which allows you to add comments to a document by freehand drawing), the entry for a comment on the Comments panel will contain context information as follows:
Right-click to finalize the drawn shape and access its related text box in the Active Comments section.
The display and appearance of comments is controlled from the Document Comments region on the Data Management - Servers page of the Preferences dialog. Controls are provided independently for comments displayed on schematic and PCB. To turn off display of comments in the workspace, relying on just the Comments panel, disable the respective Show Comment Threads option. For information regarding the other controls that relate to the look and feel of comments and reference lines, refer to the documentation page here.
Visibility of comments in the workspace also can be controlled directly from the Comments panel. To do so, click the control at the top-right of the panel and switch between Visible and Hidden in the Visibility on canvas section.