文档注释

与已连接的工作区集成后，Altium Designer 项目可让分布在不同地点的设计团队围绕集中存储和管理的项目开展协作。设计界面支持在各种设计文档中添加评论，以增强设计协作。评论（即用户添加的备注） 可以放置在文档中，其他用户也可以回复。

Comments and Tasks 面板

放置的评论可供协作用户（拥有文档共享访问权限的用户）实时查看， 并独立于项目保存在服务器上，不会以任何方式更改项目中的文档。评论功能通过 Comments and Tasks 面板进行管理。 在 Comments and Tasks 面板中选择某条评论时，系统将打开关联的设计文档（必要时会先加载该文档）。

Comments and Tasks 面板允许您在工作区项目的活动文档中，针对指定区域或点添加评论，并将这些评论分配给工作区成员，从而为他们创建任务。该面板允许所有参与文档工作的用户添加评论和查看全部评论，而无需实际修改文档本身。此功能有助于建立高效的协作流程，尤其适合在不实际合并文档、不引发冲突的情况下指出文档中的问题。Comments and Tasks 面板实际上可以用来创建“待办事项”列表， 随着设计逐步完善， 可以解决并关闭这些评论。 放置的评论可供协作用户（拥有文档共享访问权限的用户）实时查看，并独立于项目保存在工作区中，不会以任何方式更改项目中的文档。

请注意，您既可以在 Altium Designer 中添加和管理评论及任务，也可以通过相关工作区浏览器界面的设计视图执行这些操作。这两个评论系统的功能基本相同，而且由于项目和评论数据均存储在工作区中，因此两个系统可实时同步。

有关工作区浏览器界面中评论系统的详细信息，请参阅 Commenting in the Web Viewer（Altium 365 工作区、Enterprise Server 工作区）。

支持评论的文档类型

原理图

可以在原理图文档中针对对象、特定点或区域添加评论。

PCB

可以在 PCB 文档中（二维布局模式下）针对对象、特定点或区域添加评论 – 。

Draftsman

可以在 PCB、多板或线束设计项目的 Draftsman 文档中针对特定点或区域添加评论 – 。

多板原理图

可以在多板原理图文档中针对对象或特定点添加评论 – 。

多板装配

可以在多板装配文档中针对特定点添加评论 – 。

线束接线图和布局图

可以在线束设计 项目的接线图或布局图文档中针对对象、特定点或区域添加评论。

ActiveBOM

可以在 ActiveBOM 文档中针对某一行添加评论 – 。

访问评论和任务面板

在工作区项目中，可通过以下方式访问该面板：

• 单击设计空间右下角的 Panels 按钮，然后选择 Comments and Tasks。

  设计空间右下角菜单中，面板名称旁的工作区图标表示需要连接到工作区 才能查看相应面板的数据。蓝色图标（）表示当前已连接到工作区。 灰色图标（）表示当前未 连接到工作区，系统会引导您先连接到工作区，然后才能访问面板数据。

• 从主菜单中选择 View » Panels » Comments and Tasks 命令。

• 双击设计空间中已放置评论的标记图钉。

未连接到工作区时添加评论

在使用评论功能之前，请确保您已连接到您的工作区，并已打开一个项目及其中一种支持评论的文档（包括原理图、2D PCB、Draftsman 和 ActiveBOM）。使用 File » Open Project 命令，从已与您共享的工作区项目中选择一个项目。Comments and Tasks 面板将提供有关这些前提条件的提示。

“评论和任务”面板选项

使用 Comments and Tasks 面板顶部的按钮，设置评论在面板和编辑器空间中的显示情况，并指定是否通知被提及的用户。

面板中的 按钮用于切换文档上评论标记图钉的可见性。您仍可照常选择“评论和任务”面板列表中的评论条目。

使用面板中的筛选下拉菜单 () 配置评论筛选条件，并使用相关的 按钮在筛选视图与未筛选视图之间切换。

• TYPE - 启用要显示的类型。默认情况下，所有类型均已启用。

• SCOPE - 启用 Current document 可仅显示当前文档的评论。

• ASSIGNEE - 默认情况下，所有选项均未启用。因此，将显示所有任务/评论，并按姓名排序（列表中的第一个条目为当前用户）。选中一个或多个用户的复选框后，将显示这些用户对应的条目。

• Clear Filters - 用于将筛选条件快速恢复为默认设置。

使用 按钮菜单中的选项配置评论可见性和通知：

• Unresolved Only – 列表中不包含已解决的评论。

• Notification settings – 单击以打开 Notification Settings 对话框，配置电子邮件提醒的接收方式：接收此设计中所有评论活动的提醒 (All)、仅接收提及您或分配给您的评论的提醒 (My)，或完全不接收电子邮件提醒 (None)。► 电子邮件内容示例。

• Export Comments – 单击以打开 Comment Export Configuration 对话框，配置将评论导出为 PDF 文件的设置。

  

输出的 PDF 将包含设计中评论的相关信息：评论 ID、作者、创建日期和时间、评论文本、受指派人（适用于任务）以及状态（对于评论，显示其是否为 Resolved；对于任务，显示其 To Do / In Progress / Resolved 状态）。您可以选择导出与设计相关的所有评论（不论评论的创建时间），也可以仅导出在特定设计发布版本之间创建的评论。此外，还有几个选项可用于指定生成的 PDF 文档中包含哪些截图。这两类截图共同提供了评论所在位置及其所针对内容（点、元件或区域）的信息。如果这两个选项均不勾选，则只会导出评论本身。配置完成后，单击 Export 以生成 PDF，并在随后出现的对话框中指定保存位置和文件名（默认使用项目名称）。

• Entire designs snapshots - 为在指定时间 Period 内有评论的每个源文档包含一张快照。快照通过带编号的评论标记，直观地显示评论在文档中的位置。
• Original design screenshots - 包含创建评论时拍摄的原始快照（即在主设计空间中单击评论标记时，可在 Contextual Commenting 窗口中查看的快照）。此快照显示评论所针对的点、区域或元件。

放置

要在基于对象的图形编辑器（例如原理图、2D PCB 或 Draftsman）的设计空间中放置评论，请先运行相应命令。可以通过以下任一方式执行此操作：

• 单击 Comments and Tasks 面板中的 按钮。

• 单击设计空间右上角附近的 。

• 从主菜单中单击 Place » Comment。

• 使用 Ctrl+Alt+C 键盘快捷键。

• 在设计空间中右键单击，然后选择 Comment。

根据文档类型（见上文），可以将评论关联到活动文档中的某个对象、特定点或区域。该命令将启动评论放置模式，光标会变为带有蓝色圆圈的十字光标，用于检测并高亮显示可供选择的对象：

• 单击高亮显示的对象，将评论附加（固定）到该对象。

• 单击未高亮显示的区域，将评论附加到文档中的该特定点。

• 在对象之外的位置单击并拖动光标，创建一个矩形高亮区域，并将评论附加到指定区域 ()。

在 ActiveBOM 文档中，单击某个单元格，即可为 BOM 中的相应行添加评论。也可以右键单击某一行，然后选择 Comment 命令，为该行添加评论。

执行放置操作后，将打开评论输入对话框，其中提供用于输入评论文本的字段；对于图形文档，还提供一个附加选项，可在适用情况下向评论添加手绘图 ()。选择 Assign a task to 选项，可将任务分配给自己或评论中提及的某位用户（详见下文）。单击 确认创建评论，评论将与文档上一个带编号的图钉标记关联，同时在 Comments and Tasks 面板中添加一条评论摘要条目。

在对象上放置评论、在评论中提及另一位已注册用户、移动评论的图钉指示标记，以及向评论添加手绘图。

提及与任务分配

除了在评论输入对话框中输入文本外，还可以通过输入 @ 字符，添加对已连接工作区中注册的任何其他用户或角色的“提及”引用。从下拉列表中选择姓名/电子邮件地址，即可将该用户（工作区成员）的引用添加到评论中，同时将其添加为 Assign a task to 条目——实际上，这会将一个 task 分配给该用户。如果不希望将此评论视为专门分配给该用户，请取消选中后一选项。也可以提及角色组（例如“工程师”），从而提及该组中的所有用户。

如果被提及的用户无权访问当前项目，系统会提示您与该用户共享项目。如果您是项目所有者或工作区管理员，则可以使用此选项。用户访问权限通过 共享对话框授予；该用户将收到一封电子邮件，通知其已获得共享访问权限。如果取消共享对话框，项目将不会被共享，但评论仍会正常发布。

► 查看有关共享设计的更多信息。

将任务分配给用户后，该用户的头像/照片将显示在评论对话框的左上角，以及 Comments and Tasks 面板中的评论卡片上。此外，任务将以项目名称和序号命名（例如 Kame_FMU-1），而不是像普通评论那样仅使用数字。此名称也会显示在评论对话框和评论卡片中。单击该名称，即可在工作区的浏览器界面中打开项目的 Tasks 页面，并在任务列表中定位所选任务。

定位

在放置评论期间或之后，可以将评论对应的“图钉”拖动到新位置，以移动评论在编辑器空间中的位置。选中评论图钉后，会显示一条连接到其关联对象或区域的连线。

请注意，在首次放置评论时，也可以在放置模式下（）通过单击并拖动来调整其位置。

粘贴图像

要在评论中添加图像，请先在 Explorer 窗口或浏览器页面中右键单击图像，将图像复制到剪贴板。要附加该图像，请在评论本身（显示 Add others with @ or paste images 的字段中）右键单击并选择 Paste （或使用 Ctrl+V 快捷键）。 

每张图像最大为 2MB。将图像粘贴到评论中后，单击图像即可显示完整图像，如右图所示。

您也可以发布仅包含粘贴图像而不含任何文本的评论，如下所示。

绘图

放置或编辑评论时，选择 选项按钮，即可使用随即出现的画笔光标添加手绘图形。单击并拖动以绘制线条，然后右键单击以完成绘制，并将图形关联到当前选中的评论。

要访问 Properties 面板的 Freehand Drawing 模式，请在手绘模式处于活动状态时（设计空间中会显示 图标）按 Tab 键。这些选项允许您通过 Commands 下拉菜单撤销和重做评论，并通过 Properties 下拉菜单更改宽度、大小和颜色。

常规任务

常规任务（应用于当前项目，但不与项目评论或文档关联的任务）会在面板中列于项目条目下的独立分组中。面板中会为常规任务显示相同的内容和属性（受理人、优先级等）。

常规任务列在 Comments and Tasks 面板中。

单击面板中的常规任务条目，即可访问其评论对话框。使用该对话框可为选定的常规任务发布评论（包括含有粘贴图像的评论）。

游离评论

当项目文档被移除或其 UniqueID 发生更改时，该文档的评论可能会变为“游离”状态。您仍可从面板的 Detached Comments 可折叠区域访问这些评论。单击 Comments and Tasks 面板中某条游离评论的卡片，即可在当前打开文档的设计空间中显示其对话框。

使用评论

放置在设计文档中的评论会同时显示在 Comments and Tasks 面板中（以一系列编号条目的形式）和相应的文档编辑器中（以带编号的图钉图形的形式）。每个面板条目代表一个评论会话，并提供摘要信息，包括评论者、评论时间、初始评论文本、任何已添加的提及或分配，以及会话回复数。

选择 Comments and Tasks 面板中的条目，或单击设计空间中与其关联的图钉，即可打开评论会话。这会在文档编辑器中高亮显示该评论，并打开评论条目对话框，其中包含初始评论和所有用户回复。如果所选评论关联的是另一个设计文档，系统将打开该文档（必要时会先加载）。

通过选择设计空间中的图钉标记，以及选择 Comments and Tasks 面板中的条目来浏览评论。

评论对话框

您可以通过弹出的评论对话框与已放置的评论进行交互。该对话框会显示所选评论会话中的所有条目，并提供预览、回复、编辑、解决和删除条目的选项。首次放置评论时，或在 Comments and Tasks 面板或设计空间中选择已放置的评论时，该对话框会打开。按 Esc 或单击设计空间即可关闭评论对话框。

预览

选择初始评论中的 Original Snapshot 选项，可查看放置该评论时编辑器区域的截图。单击截图右上角的 图标或截图本身，即可打开全尺寸预览（单击此预览右上角的  图标或图像本身可将其关闭）。

回复

在 Reply 字段中输入文本，并可选择添加用户提及（“@”），以向评论会话添加新条目。选择 Assign a task to 选项，可创建分配给下拉列表中指定用户的任务。 单击  以确认该条目。

编辑和删除

评论作者可以使用评论  菜单中的 Edit 选项编辑已有评论。单击  按钮以确认对评论的编辑。

使用 Delete 选项可移除当前选定的评论。请注意，如果删除的是初始评论（而非回复），则整个会话都会被移除。

使用 Convert to Task 选项可将评论转换为分配给您自己的任务。

使用 Copy Link 选项可复制评论会话的 URL。通过此链接，可在工作区浏览器界面的 Web Viewer 中打开此项目，并将评论所涉及的对象、点或区域缩放并居中显示。

解决

单击 / 按钮，可在 Resolved 和 Unresolved（默认）之间切换评论状态。已解决的评论（作为已完成项关闭）处于非活动状态且无法编辑，其在 Comments and Tasks 面板中的条目和文档上的图钉标记都会变灰。

设置任务优先级和状态

如果任务评论已分配给用户，则可以设置其优先级和状态。任务创建后，其优先级会立即设为 Medium，状态设为 To Do，但可以通过单击评论对话框顶部的相应控件进行更改。

提交标签、发布修订版 ID 和设计评审信息 

在 Altium Designer 中查看相关评论/任务时，提交标签和发布修订版 ID 会同时显示在 Comments and Tasks 面板和评论对话框中。

• 在 Web 查看器中查看带标签提交的设计快照时创建的评论，将包含关联的标签名称。单击标签名称链接，可在 Web 查看器中打开相关的提交快照。

• 在 Web 查看器中查看特定发布版本时创建的评论，将包含发布修订版 ID。 单击发布修订版 ID 链接，可打开此发布版本的制造门户。

• 在 Web 查看器中查看设计评审快照时创建的评论，将包含设计评审条目。单击设计评审链接，可打开该评审的页面。

使用 Jira 任务

如果您的 Altium 365 工作区已启用并配置 Jira 集成，则已放置的评论中会增加一个选项，用于在您的 Atlassian Jira® 服务中创建并关联 Jira 事项。与常规评论及其关联任务一样，您可以在设计文档中查看、编辑已创建的 Jira 事项并对其发表评论，也可以通过 Comments and Tasks 面板查看或选择这些事项。

已创建的 Jira 任务实例会与 Jira 空间中相应的事项同步。Jira 事项与工作区任务之间的双向数据同步，让您能够通过 Jira 空间结合 Altium 365 来管理设计项目。

创建 Jira 事项

要为设计项目创建 Jira 事项任务，请先按常规方式放置一个评论实例，然后在评论对话框中选择 Jira Issue 选项。接着选择事项类型并添加摘要，以创建同步的 Jira 事项任务。

在评论对话框或 Comments and Tasks 面板中选择工作区 Jira 事务的 Task ID，即可在默认浏览器的新标签页中直接打开 Jira 空间中的该事务。工作区的 Task ID 映射到 Jira 空间中的 Issue Key，并且摘要、描述、经办人和评论等主要 Jira 参数会在这两个实例之间进行映射。创建该 Jira 事务的工作区用户即为 Jira 端的事务报告人。请注意，如果在创建工作区 Jira 事务时选择了 Attach original snapshot 选项（见上文），当前工作区文档的快照图像将作为 Jira 附件添加。

放置工作区 Jira 任务后，将在 Jira 空间中创建一个同步的 Jira 事务。两者通过工作区 Task ID 与 Jira Issue Key 的映射建立关联。

除了工作区事务与 Jira 事务之间映射的参数之外，与任务相关的 Priority 和 Progress 状态设置也会同步。例如，将工作区事务任务的优先级状态从 Medium 改为 High，将立即反映在 Jira 端的事务中；同样，在 Jira 端将进度状态从 To Do 改为 In Progress，也会相应更改工作区 Jira 事务的状态。您可能需要刷新数据（单击 Comments and Tasks 面板顶部的  按钮）才能看到更新后的数据。

链接到 Jira 事务

Altium 365 Jira 集成还允许通过评论对话框的 Jira Issue 模式，将工作区任务链接到 Atlassian Jira 服务中的现有 Jira 事务。您可以链接到指定 Jira 项目中的任意事务，该事务随后将与工作区 Jira 任务同步。

❯ ❮ Javascript ID：LinkJiraIssue

在要与现有 Jira 事务关联的文档区域或对象上放置一个评论实例，然后在评论对话框中选择 Jira Issue 模式和 Link Issue 选项。 使用 Select or search issues 下拉列表选择要链接到新放置的 Jira 任务实例的 Jira 事务（以 Summary 文本显示）。在文本字段中开始输入，即可搜索所需的 Jira 事务。 对话框的 Jira Issue 下拉列表将显示从 Jira 空间中选定的事务。如有需要，可选中 Attach original snapshot 选项，将当前文档视图的图像传输到 Jira。 单击 Post 按钮，在工作区 Jira 任务与所选 Jira 事务之间建立链接。 新建的 Jira 事务任务将显示在 Comments and Tasks 面板和评论对话框中，其中包含所有现有（或新增）的评论 – 选择对话框的 Show all Replies 选项可查看完整列表。

链接的 Jira 事务现已与工作区 Jira 任务同步，后者包含事务的 Comments，并设置为该 Jira 事务所定义的 Progress 和 Priority 状态 – 在本例中为 In Progress 和 High。请注意，Jira 事务的 Web links 条目现在将显示已有一个 Altium 365 工作区 Jira 任务链接（或重新链接）到此事务。

在工作区评论对话框的 Link Issue 模式下指定现有 Jira 事务的 Jira Issue 条目，即可将其链接到工作区任务。

待办事项面板

虽然您连接的 Workspace 提供了上述全面的评论和任务分配功能，但您也可以访问 To-Do 面板来跟踪任务。To-Do 面板列出了当前为活动项目定义的所有待办事项。待办事项用于提醒您稍后需要针对某个文档执行的任务。

To-Do 面板

待办事项面板的内容和使用

To-Do 面板可以列出活动项目的两种待办事项：

• 项目级待办事项。
• 文档级待办事项——添加到项目中的文本文档中。

每个待办事项都会显示以下信息：

• Done - 通过此复选框，您可以在完成所定义的任务后勾选该事项。
• Action Item - 实际需要执行的任务。
• Priority - 待执行任务的重要程度（Lowest、Low、Normal （默认）、High、Highest）。
• Document - 对已添加文档级待办事项的源文档的引用。
• Owner - 可以是输入任务的人员姓名，也可以是实际执行任务的人员姓名。
• Category - 可以是待执行任务所属的项目具体领域（例如，原理图、设计规则、布线、约束等）。

添加项目级待办事项

项目级待办事项直接在面板中添加。添加任何事项之前，请确保设计编辑器窗口中的活动文档属于您要为其定义待办事项的项目，并且是该项目的设计文档之一。

要添加新的待办事项，请在面板内右键单击，然后从弹出的上下文菜单中选择 Add Project To-Do Item 条目。此时将打开 Edit To-Do Item 对话框。

使用此对话框，为项目中必须执行的任务输入合适的文本。使用对话框中的可用字段定义 task's Priority, Owner, and Category。按要求定义事项后，单击 OK，将新事项添加到面板中。

添加文档级待办事项

文档级待办事项添加到文本格式的源文档中（例如 VHDL 文件、约束文件、嵌入式源代码文档等）。添加任何事项之前，请确保所需文档在设计编辑器窗口中处于活动状态，并且该文档属于您当前正在为其定义整体待办事项的项目。

要添加新的待办事项，请将文本光标放在文档中需要插入待办事项的位置，右键单击，然后从弹出的菜单中选择 Add To-Do Item 条目。此时将显示 Edit To-Do Item 对话框。 使用此对话框，输入与文档中必须执行的任务相关的合适文本。使用对话框中的可用字段，为任务定义 Priority、 Owner 和 Category（例如，格式检查、代码审查等）。 按要求定义待办事项后，单击 OK 关闭对话框，并将焦点返回当前文档。该待办事项的条目将显示在 To-Do 面板中，同时也会出现在当前文本光标所标记的位置。该条目将以注释形式显示（位于为该文档类型定义的注释定界符之间），其中包含事项的实际文本和唯一标识符，如下图所示。

右键菜单

右键菜单提供以下命令：

• Goto Source - 当面板中选中的事项为文档级待办事项时，此命令可用。使用此命令可打开该事项的 Document 字段所引用的关联源文档（如果尚未打开），并使其成为设计编辑器窗口中的活动文档。文本光标将定位到待办事项文本的开头。
• Add Project To-Do Item - 为活动项目向面板添加项目级待办事项。
• Edit - 编辑选中的待办事项。此时将显示 Edit To-Do Item 对话框，供您进行所需的更改。
• Delete - 从面板中删除选中的待办事项。
• Show Completed Items - 启用此选项后，面板中将仅显示已标记为完成的待办事项（已启用 Done 选项）。
• Report - 生成包含面板中当前显示的所有待办事项的报告。启动此命令后，将打开 Report Preview 对话框，您可以在其中配置、 打印报告，以及将报告导出为各种文件格式。

注意事项

• 如果面板中定义了文档级待办事项，并且对应的源文档是设计编辑器窗口中的活动文档，则面板中该待办事项的整个条目文本将以粗体显示。
• 双击面板中的待办事项条目将打开 Edit To-Do Item 对话框，供您修改任务定义。
• 单击任意列的列标题，即可按该列对面板中的条目进行排序。单击一次按升序排序，再次单击则按降序排序。
• 直接筛选功能允许您直接在面板中键入内容，以快速跳转到某个待办事项条目。您可以根据面板中的任意数据列进行筛选。使用 Right Arrow 和 Left Arrow 键切换用于筛选的列，也可以直接单击某一列中的字段。 要使用此筛选功能，请在数据列中单击，然后键入要跳转到的条目的首字母。该列中以您键入的字母开头的第一个条目将被选中，并且该字母将突出显示，表明当前正根据键入的字母筛选该列内容。