文档注释

与已连接的工作区集成后，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 面板顶部的按钮，设置评论在面板和编辑器空间中的显示情况，并指定是否通知被提及的用户。

输出的 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。使用此链接可在 Workspace 浏览器界面的 Web Viewer 中打开该项目，并将评论所涉及的对象、点或区域缩放并居中显示。

解决

单击 / 按钮，可将评论状态在 Resolved 和 Unresolved（默认状态）之间切换。已解决的评论（因完成而关闭）处于非活动状态且不可编辑，其在 Comments and Tasks 面板中的条目和文档上的图钉标记均显示为灰色。

设置任务优先级和状态

如果任务评论已指派给某个用户，就可以设置其优先级和状态。任务最初会立即设为 Medium 优先级和 To Do 状态，但可以通过单击评论对话框顶部的相关控件来更改。

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

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

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

• 在 Web Viewer 中查看特定发布版本时创建的评论，会包含发布修订 ID。单击发布修订 ID 链接，可打开该发布版本的 Manufacturing Portal。

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

使用 Jira 任务

如果您的 Altium 365 工作区已启用并配置 Jira 集成，则放置的评论将包含额外选项，可在您的 Atlassian Jira® 服务中创建并关联 Jira 问题。与常规评论及其关联任务一样，创建的 Jira 问题可以在设计文档中查看、编辑和评论，也可以通过 Comments and Tasks 面板查看和选择。

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

创建 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 - 当面板中选中的事项为文档级待办事项时，此命令可用。使用此命令可打开该事项“文档”字段所引用的关联源文档（如果尚未打开），并使其成为设计编辑器窗口中的活动文档。文本光标将置于待办事项文本的开头。
• 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 键切换用于筛选的列，或直接单击某列中的字段。 要使用此筛选功能，请在数据列中单击，然后键入要跳转到的条目的首字母。该列中以所键入字母开头的第一个条目将被选中，并且该字母会高亮显示，表明列内容是根据所键入的字母进行筛选的。