文档注释

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 工作区、企业服务器工作区），了解有关工作区浏览器界面中注释系统的详细信息。

支持注释的地方

示意图

注释可应用于原理图文档中的对象、特定点或区域。

PCB

注释可应用于 PCB 文档中的对象、特定点或区域（二维布局模式） - 。

绘图员

注释可应用于 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面板设置面板和编辑器空间中注释的可用性，并指定是否通知被提及的用户。

面板上的 按钮可切换文档上评论标记针的可见性。评论和任务面板列表中的评论条目仍可照常选择。

使用 Comments and Tasks面板 () 配置注释过滤，并使用相关的 按钮在过滤和未过滤视图之间切换。

• Tasks only - 启用此选项可仅显示分配给用户的评论。
• ASSIGNED TO - 所有选项默认为禁用。因此，所有任务/注释都会显示，并按名称排序（列表中的第一个条目是当前用户）。如果用户的复选框被启用，则会显示被启用用户的条目。

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

• Unresolved Only- 已解决的评论不包括在列表中。

• Current document 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窗口中的快照）。这显示了注释适用的点、区域或组件。

  将注释导出为 PDF 文件也可以通过输出任务文件进行配置和生成，作为发布项目的一部分。添加一个 Export Comments输出器作为 Report Outputs类别的一部分。

  请注意，注释导出功能仅适用于项目所在工作区的成员。在工作区之外与之共享项目的用户则无法使用该功能。

放置注释

要在基于对象的图形编辑器（如原理图、二维 PCB 或 Draftsman）的设计空间中放置注释，首先要运行相关命令。可通过执行以下操作之一来实现：

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

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

• 点击 Place » Comment主菜单。

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

• 右键单击 Comment。

根据文档类型（见上文），可以将注释分配给活动文档上的一个对象、一个特定点或一个区域。该命令将调用注释放置模式，光标将变为带有蓝色圆圈的十字准线，该圆圈可检测并高亮显示要选择的对象：

• 单击高亮显示的对象可将注释附加到该对象上。

• 单击未突出显示的区域，可将注释附加到文档上的特定点。

• 单击远离对象的位置并拖动光标，可创建一个矩形高亮区域，并将注释附加到指定区域 ()。

在 ActiveBOM 文档中，单击 ActiveBOM 文档中的单元格可为 BOM 的该行添加注释。右键单击某一行，然后选择 Comment命令为该行添加注释。

然后，放置操作将打开一个注释输入对话框，该对话框提供了一个输入注释文本的字段，对于图形文档，还提供了一个在注释中添加自由绘图的附加选项（ ）。选择 Assign a task to选项，为自己或评论中提到的某个用户分配任务（详见下文）。单击 确认注释的创建，这将把注释与文档上的编号图钉标记关联起来，同时还将注释摘要条目添加到 Comments and Tasks面板。

在对象上放置注释，在注释中提及另一个注册用户，移动注释的针形标记，并在注释中添加自由绘图。

注释和任务分配

除了在注释输入对话框中输入文本外，还可以通过输入 @字符。从下拉列表中选择一个名称/电子邮件，即可将用户（工作区成员）参考添加到注释中，并作为一个 Assign a task to条目--基本上，一个 task将分配给该用户。如果不希望评论被视为指定给该用户，请取消选中后一个选项。角色组（如 "工程师"）及其组成用户也可作为提及添加。

如果被提及的用户没有访问当前项目的权限，则会邀请您与该用户共享项目。如果您是项目所有者或工作区管理员，则可以使用此选项。用户访问权限通过共享对话框授予；用户将收到一封电子邮件，通知他们共享访问权限。如果取消 "共享 "对话框，则不会共享项目，但会像往常一样放置注释。

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

当任务分配给某个用户时，该用户的图像/照片将显示在注释对话框的左上方，而注释磁贴则显示在 Comments and Tasks面板中的注释磁贴。此外，任务名称将包含项目名称和序列号（例如、 Kame_FMU-1），而不是像普通注释那样使用简单的数字。该名称也会显示在注释对话框和注释磁贴中。单击该名称可打开 Tasks在工作区的浏览器界面中打开项目页面，并在任务列表中聚焦所选任务。

定位

在放置过程中或之后，通过拖动相关 "引脚 "到新位置，可以移动评论在编辑器空间中的位置。选中后，注释引脚会包含一条与其关联对象或区域的连接线。

请注意，在置放模式下（ ），也可以通过单击和拖动来定位注释的初始置放位置。

粘贴图片

您可以将图像添加到注释中，方法是先从一个窗口或浏览器页面中复制图像，然后用鼠标右键单击 Explorer 窗口或浏览器页面上复制图片，右键单击图片，即可将图片复制到剪贴板。要附加图片，请右键单击 Paste或 Ctrl+V 快捷键）。 Add others with @ or paste images).

每张图片的最大容量为 2MB。粘贴到注释中后，单击图片即可显示完整图片，如右图所示。

如果评论中只粘贴了图片而没有任何文字，您也可以发表评论，如下图所示。

绘图

在放置或编辑评论时，选择 选项按钮，即可用由此产生的钢笔光标添加自由绘图。单击并拖动以创建线条，然后单击右键完成并将绘图与当前选定的评论关联。

要访问 Freehand Drawing 模式 Properties面板的模式，按 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 和设计审核信息

在面板和注释对话框中查看适用的注释/任务时，都会显示提交标签和版本修订 ID。 Comments and Tasks面板和 Altium Designer 中的注释对话框中查看适用的注释/任务时，都会显示提交标签和版本修订 ID。

• 查看标记提交的设计快照时，在 Web 查看器中创建的注释将包括相关标记名称。单击标签名称链接可在 Web 查看器中打开相关的提交快照。

• 查看特定版本时在 Web 查看器中创建的注释将包括版本修订 ID。单击版本修订 ID 链接可打开此版本的制造门户。

• 查看设计审核快照时在 Web 查看器中创建的注释将包括设计审核条目。单击设计审核链接可打开审核页面。

使用 Jira 任务

如果为 Altium 365 工作区启用并配置了 Jira 集成，则放置的注释将包括在 Atlassian Jira® 服务中放置和链接 Jira 问题的附加选项。与传统的注释及其相关任务一样，放置的 Jira 问题可在设计文档中查看、编辑和注释，并通过 Comments and Tasks面板查看/选择。

放置的 Jira 任务实例与 Jira 空间中的相应问题同步。Jira 问题和 Workspace 任务之间的双向数据同步允许通过 Jira 空间和 Altium 365 进行设计项目管理。

创建 Jira 问题

要为设计项目放置 Jira Issue 任务，首先要以常规方式放置注释实例，然后在注释对话框中选择 Jira Issue选项。然后选择问题类型并添加摘要，创建同步的 Jira 问题任务。

❯ ❮ JavascriptID：创建 JiraIssue

通过首先放置一个注释实例，在当前项目文档中放置一个 Jira 任务。可从 Comment下拉菜单中提供替代 Jira 模式。 从对话框的 Jira Issue选项，调用 Jira 任务放置。 Comment菜单中选择该选项。 单击 Create Issue选项。 从下拉列表中选择要创建的问题类型。 Issue Type下拉列表中选择要创建的问题类型，其中包括 Jira 服务中可用的类型。 输入问题 Summary和可选描述/受权人。下拉列表 Assignee下拉列表将只包括您 Jira 账户的注册用户。选择 Post确认。 Jira 问题会放置在初始文档注释位置，包含在 Comments and Tasks面板中，并提供指向 Jira 空间中问题的链接，还包括对其任务优先级 (Medium, High等）和状态（To Do, In Progress等）设置。

选择 Task ID在注释对话框或 Comments and Tasks面板，在默认浏览器的新标签页中直接打开 Jira 空间中的该问题。工作区 Task ID映射到 Issue Key在 Jira 空间中，Jira 的主要参数（如摘要、描述、受让人和注释）会在两个实例之间进行映射。创建 Jira 问题的工作区用户是 Jira 方面的问题报告人。请注意，如果在创建 Workspace 时选择了 Jira 附件选项，则当前 Workspace 文档的快照图像将作为 Jira 附件包含在内。 Attach original snapshot选项，则当前 Workspace 文档的快照图像将作为 Jira 附件包含在内（见上文）。

放置的 Workspace Jira 任务将在 Jira 空间创建同步的 Jira 问题。两者之间的联系是通过 Workspace Task ID与 Jira Issue Key.

除了工作空间和 Jira 问题之间的参数映射外，与任务相关的 Priority和 Progress状态设置也是同步的。例如，将 Workspace 问题任务从 Medium优先级状态移动到 High优先级状态将立即反映到 Jira 问题中，进度状态从 To Do到 In Progress的进度状态也会同样改变 Workspace Jira 问题的状态。可能需要刷新数据（通过单击面板顶部的 按钮运行 Comments and Tasks面板上的按钮运行），以查看更新的数据。

链接到 Jira 问题

Altium 365 Jira 集成还允许通过注释对话框的 Jira Issue模式。您可以链接到指定 Jira 项目中的任何问题，然后与工作区 Jira 任务同步。

❯ ❮ JavascriptID：LinkJiraIssue

在您希望与现有 Jira 问题关联的文档区域或对象上放置注释实例，然后选择 Jira Issue模式和 Link Issue选项。 使用 Select or search issues下拉菜单选择将链接到新放置的 Jira 任务实例的 Jira 问题（显示为 Summary文本），该问题将链接到新放置的 Jira 任务实例。在文本字段中开始键入，搜索所需的 Jira 问题。 对话框的 Jira Issue下拉菜单将显示从 Jira 空间选择的问题。如果需要，请选中 Attach original snapshot选项，将当前文档视图的图像传输到 Jira。 单击 Post按钮在工作区 Jira 任务和所选 Jira 问题之间建立链接。 新的 Jira 问题任务将显示在 Comments and Tasks面板和注释对话框中，其中将包括任何现有（或添加）的注释--选择对话框的 Show all Replies选项查看完整列表。

链接的 Jira 问题现在与工作区 Jira 任务同步，工作区 Jira 任务包括问题 Comments并设置为 Progress和 Priority状态。 In Progress和 High在本例中。请注意，Jira 问题 Web links条目现在将显示 Altium 365 Workspace Jira 任务已链接（或重新链接）到此问题。

通过在工作区注释对话框的 Jira Issue条目。 Link Issue模式。

待办事项面板

虽然您连接的工作区提供了上述用于注释和任务分配的一整套功能，但您还可以访问 To-Do面板来跟踪任务。面板 To-Do面板会列出当前为活动项目定义的所有待办事项。待办事项可用于提醒稍后需要执行的与文档相关的任务。

面板 To-Do面板

To-Do Panel Content and Use

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

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

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

• Done - 该复选框可让您在定义的任务完成后选中该项目。
• Action Item - 实际需要执行的任务。
• Priority - 要执行的任务的重要性 (Lowest, Low, Normal (默认）、 High, Highest).
• Document - 指向源文件的引用，源文件中已添加了文件级 To-Do 项目。
• Owner - 这可以是输入任务的人或实际执行任务的人的姓名。
• Category - 这可能是要执行的任务所属的项目特定区域（如原理图、设计规则、路由、限制等）。

添加项目级待办事项

项目级 To-Do 项目可在面板内添加。在添加任何项目之前，请确保设计编辑器窗口中的活动文档是您要定义 To-Do 项目的项目设计文档之一。

要添加新的 To-Do 项目，请在面板上单击右键，然后从随后出现的右键菜单中选择 Add Project To-Do Item条目。对话框将打开。 Edit To-Do Item对话框。

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

添加文档级待办事项

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

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

右键菜单

右键菜单提供以下命令：

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

注意事项

• 如果在面板中定义了文档级的待办事项，且相应的源文档是设计编辑器窗口中的活动文档，则面板中整个待办事项条目的文本将变为粗体。
• 双击面板中的 To-Do 项目条目将打开 Edit To-Do Item对话框，以便修改任务定义。
• 点击面板中任何一列的标题，都可以对该列中的条目进行排序。单击一次可按升序排序；再次单击可按降序排序。
• 通过直接筛选，您可以在面板中直接键入，快速跳转到待办事项条目。您可以根据面板中的任何数据列进行筛选。使用 Right Arrow和 Left Arrow键在列之间切换进行筛选，或直接单击列中的字段。要使用此筛选功能，请单击数据列，然后键入要跳转的条目的第一个字母。从键入的字母开始，该列中的第一个条目将被选中，该字母将突出显示，表明根据键入的字母过滤列内容。