文档注释

您正在阅读的是 22. 版本。关于最新版本,请前往 文档注释 阅读 24 版本

父页面: 处理文档

当Altium Designer项目与Altium工作区集成时,可以使分散的设计团队协作地工作于通过该工作区集中存储和管理的项目。为了增强设计协作过程,设计界面支持对设计文档进行评论。评论——用户添加的注释——可以应用于原理图或PCB文档上的一个点、对象或区域,并且可以由其他用户回复。

“评论和任务”面板
评论和任务”面板

放置的评论可以实时提供给协作用户——那些拥有文档共享访问权限的用户——并且独立于项目保存到服务器上,不以任何方式更改其组成文档。评论功能通过评论和任务面板进行管理。

“评论和任务”面板
评论和任务”面板

评论和任务面板允许您在工作区项目的活动文档中的定义区域或点上添加评论,并将这些评论分配给工作区成员,本质上为他们创建任务。该面板允许所有正在文档上工作的用户添加评论并查看所有评论,而无需实际修改文档本身。这个功能有助于促进强大的协作流程,并且在需要指出文档内的问题而不实际合并和接收冲突时非常宝贵。评论和任务面板本质上可以用来创建一个“待办事项”列表,并且随着设计的成熟,评论可以被解决和关闭。放置的评论可以实时提供给协作用户——那些拥有文档共享访问权限的用户——并且独立于项目保存到工作区,不以任何方式更改其组成文档。

请注意,使用Altium Designer标准订阅不支持创建和管理任务的功能。因此,使用此级别的Altium 365访问权限时,此功能将不可用,面板将被命名为 评论

连接到企业服务器工作区时,此功能也不可用。

有关从工作区角度查看项目的信息,请参见工作区项目Altium 365工作区企业服务器工作区)。

请注意,可以在Altium Designer和相关工作区的浏览器界面设计视图中添加和管理评论和任务。这两个评论系统的功能基本相同,由于项目和评论数据都存储在工作区中,因此这两个系统可以实时协同工作。

►有关工作区浏览器界面中评论系统的详细信息,请参见Web查看器中的评论Altium 365工作区企业服务器工作区)。

请注意,当连接到NEXUS服务器工作区时,面板中创建和管理任务的功能不可用。在这种情况下,面板将被命名为评论

有关从工作区角度查看项目的信息,请参见工作区项目(适用于Altium 365工作区NEXUS服务器工作区)。

请注意,可以在Altium NEXUS和相关工作区的浏览器界面设计视图中添加和管理评论和任务。这两个评论系统的功能基本相同,由于项目和评论数据都存储在工作区中,因此这两个系统可以实时协同工作。

►有关工作区浏览器界面中评论系统的详细信息,请参见Web查看器中的评论(适用于Altium 365工作区NEXUS服务器工作区)。

评论和任务面板访问

以下方式可以从工作区项目访问面板:

  • 点击设计空间右下角的面板按钮,然后选择评论和任务

    设计空间右下角菜单中面板名称旁的工作区图标表示查看关联面板数据需要连接到工作区。蓝色图标()表示当前已连接到工作区。灰色图标()表示当前未连接到工作区,在访问面板数据之前,你将被引导连接到工作区。
  • 从主菜单中选择查看 » 面板 » 评论和任务命令。
  • 双击设计空间中放置的评论标记针。
要访问评论和任务面板,活动文档必须是打开的工作区项目的原理图或PCB文档。只有与你共享的项目才可供选择。

使用这些链接访问相应的命令文档页面:

原理图评论命令

PCB评论命令

有关从工作区角度支持项目的更多信息,请参见与连接的工作区的设计管理

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

在使用评论功能之前,请确保你已连接到你的工作区,并已打开一个项目及其原理图或PCB文档。使用文件 » 打开项目命令从与你共享的项目中选择一个工作区项目。评论和任务面板将为这些先决条件提供提示。

如果你享受Altium订阅的好处,但还没有为你的公司创建Altium 365工作区,你可以在演示模式下测试评论功能。当你从Altium Designer登录到你的Altium账户并处理本地项目时,你可以放置最多3条评论。要以完整功能模式使用评论功能并保存放置的评论,项目必须提供给工作区 - 在设计空间的弹出评论对话框下方的消息框中将提供适当的控制来执行此操作。

当你还没有激活Altium 365工作区时,尝试其演示模式的评论功能。
当你还没有激活Altium 365工作区时,尝试其演示模式的评论功能。

评论和任务面板选项

使用评论和任务面板顶部的按钮来设置面板和编辑器空间中评论的可用性,并指定是否通知提到的用户。

面板的按钮可以切换文档上评论标记针的可见性。在评论和任务面板列表中仍然可以像往常一样选择评论条目。

使用评论和任务面板中的过滤器下拉菜单()来配置评论过滤,并使用关联的 按钮在过滤视图和非过滤视图之间切换。

  • 仅任务 - 启用此选项以仅显示分配给用户的评论(标准订阅不提供此过滤器)。
  • 分配给 - 所有选项默认禁用。因此,所有任务/评论都会显示并按名称排序(列表中的第一个条目是当前用户)。当为一个或多个用户启用复选框时,将显示这些启用用户的条目。

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

  • 仅未解决 - 已解决的评论不包括在列表中。
  • 仅当前文档 - 仅显示已放置在当前活动文档上的评论。
  • 通知设置 - 点击打开通知设置对话框,并配置接收此设计中所有评论活动的电子邮件提醒(全部),仅接收提到或分配给您的评论的电子邮件提醒(我的),或根本不接收电子邮件提醒()。► 电子邮件内容示例
  • 导出评论 - 点击打开评论导出配置对话框,以配置将评论导出到PDF文件。

您可以选择导出与设计相关的所有评论,无论这些评论是何时做出的,或者只导出在特定设计版本之间做出的评论。在生成的PDF文档中包含哪些截图也有几个选项可以定义。这两者共同提供了评论所在的位置以及它适用的内容(点、组件、区域)。如果两者都不勾选,您将只得到评论本身。配置好后,点击导出生成PDF,在随后的对话框中确定存储位置和名称(默认为项目名称)。

  • 整个设计快照 - 包括在指定时间期间内包含评论的每个源文件的快照。这提供了一个视觉确认,通过编号的评论标记可以看到评论位于文档的哪个位置。
  • 原始设计截图 - 包括在创建评论时拍摄的原始快照(并且是在主设计空间中点击评论标记时从上下文评论窗口中可获取的快照)。这显示了评论适用的点、区域或组件。
导出评论到PDF也可以通过输出作业文件配置和生成,作为发布项目的一部分。在报告输出类别中添加一个导出评论输出器。

放置

要在设计空间中放置评论,请首先运行该命令。这可以通过以下任一方式完成:

  • 点击评论和任务面板中的按钮。
  • 点击设计空间右上角附近的
  • 点击主菜单中的放置 » 评论
  • 使用Ctrl+Alt+C键盘快捷键。
  • 右键点击然后从设计空间选择评论

评论可以分配给活动文档上的一个对象、一个特定点或一个区域。该命令调用评论放置模式,光标变为带有蓝色圆圈的十字形,可以检测并突出显示用于选择的对象:

  • 点击突出显示的对象,将评论附加(固定)到该对象(在原理图和PCB编辑器中)。
  • 点击未突出显示的区域,将评论附加到文档上的特定点。
  • 远离对象点击并拖动光标创建一个矩形突出显示区域,然后再次点击确认其最终形状,将评论附加到指定区域。► 查看示例

放置操作随后会打开一个评论输入对话框,提供一个用于输入评论文本的字段,并且还有一个额外选项用于在评论中添加自由手绘图(在对象上放置评论,提及另一个注册用户,移动评论的图钉指示器,并向评论中添加自由手绘图。)。选择分配任务给选项,将任务分配给自己或评论中提到的用户之一(详见下文)。点击确认创建评论,这将把评论与文档上的编号图钉标记关联,并且在评论和任务面板中添加一个评论摘要条目。

在对象上放置评论,提及另一个注册用户,移动评论的图钉指示器,并向评论中添加自由手绘图。

放置的评论将立即对所有有权访问项目的用户可用,并且也将在连接的工作区的基于浏览器的项目视图中可用。

提及和任务分配

在评论输入对话框中,可以通过输入@字符为连接工作区注册的任何其他用户或角色添加“提及”引用。从下拉列表中选择一个名称/电子邮件以将用户(工作区成员)引用添加到评论中,并且也作为一个分配任务给条目——本质上,一个任务将被分配给该用户。如果你不希望评论被特别分配给那个用户,取消勾选后面的选项。一个角色组(比如,“工程师”),以及其组成用户,也可以被添加为提及。

如果提及的用户没有访问当前项目的权限,你将被邀请与该用户分享它。如果你是项目所有者或工作区管理员,这个选项是可用的。用户访问权限通过分享对话框授予;用户将收到一封通知他们共享访问的电子邮件。如果你取消了分享对话框,项目将不会被分享,但评论将照常放置。

查看有关分享设计的更多信息

当一个任务分配给用户时,该用户的图片/照片将显示在评论对话框和评论和任务面板中评论磁贴的左上角。此外,任务将以项目名称和序列号(例如,Kame_FMU-1)命名,而不是像普通评论那样使用简单的数字。这个名称也显示在评论对话框和评论磁贴中 - 点击它将打开项目在工作区浏览器界面中的任务页面,并在任务列表中聚焦选定的任务。

在将项目保存到连接的工作区时,可以将任务引用到项目提交。正如保存到服务器对话框中的提示所述,将任务ID添加到评论字段(如评论和任务面板中所示);任务将链接到点击对话框中的确定后将创建的项目提交。

当在Altium 365 工作区浏览器界面的任务页面项目详细管理页面的任务视图中选择任务磁贴时,提交的链接将显示在任务详细信息窗格中。点击链接将打开项目的历史视图,并在时间线上突出显示相关提交。

连接提交的链接将显示在任务详细信息窗格中。将光标悬停在图片上,查看点击链接后打开的历史页面以及时间线上突出显示的相关提交。
连接提交的链接将显示在任务详细信息窗格中。将光标悬停在图片上,查看点击链接后打开的历史页面以及时间线上突出显示的相关提交。

定位

通过拖动其关联的“图钉”到新位置来移动编辑器空间中的评论位置 - 在放置期间或之后。当选中时,评论图钉包括一条连接线到其关联的对象或区域。

虽然您可以在文档编辑器中移动(拖动)评论图钉,但初始定义的点或区域不能被修改。

请注意,在初始放置期间,也可以通过在放置模式下点击和拖动来定位评论。► 查看示例.

绘图

在放置或编辑评论时,选择选项按钮,以添加自由手绘的结果笔光标。点击并拖动以创建线条,然后右键单击以完成并将绘图与当前选定的评论关联。

要访问属性面板的自由手绘图模式,请在自由手绘图模式激活时按Tab键(由设计空间中的 图标指示)。这些选项允许您在命令下拉菜单中撤销和重做评论,并在属性下拉菜单中更改宽度大小和颜色。

常规任务

常规任务(适用于当前项目但不与项目评论或文档关联的任务)在面板中以单独的组别列出,位于项目条目下。对于常规任务,面板中显示的内容和属性与常规任务相同(分配人、优先级等)。

常规任务在评论和任务面板中列出。
常规任务在评论和任务面板中列出。

可以从Altium 365工作区基于浏览器的界面的任务页面为项目创建常规任务,当访问项目的详细管理页面时。要了解更多,请参阅特定项目管理 – 任务

分离的评论

当项目文档被移除或其UniqueID发生变化时,该文档的评论可能会变成“分离的”。这些评论仍然可以从面板的分离的评论可折叠区域访问。在评论和任务面板中点击一个分离的评论磁贴,以在当前打开的文档的设计空间中显示其对话框。

PCB和制图员评论

评论也可以放置在PCB编辑器设计空间的板布局上,以及使用与原理图编辑器相同的放置方法,在制图员文档上放置。当在评论和任务面板中选择一个评论条目时,系统将打开(并在必要时加载)关联的设计文档。

PCB文档中的一个评论示例
PCB文档中的一个评论示例

制图员文档中的一个评论示例。
制图员文档中的一个评论示例。

BOM评论

评论也可以针对ActiveBOM文档中的某个项目进行放置。这可以通过以下方式完成:

  • 点击按钮,该按钮位于评论和任务面板中。
  • 点击设计空间右上角附近的
  • 使用主菜单中的工具 » 评论命令。

选择一个命令后,点击文档中的一行以添加评论。或者,右键点击一行然后选择评论命令来对这一行添加评论。

使用评论

在设计文档中放置的评论会在评论和任务面板(作为编号条目序列)和相应的文档编辑器(作为编号的图钉图形)中注册。每个面板条目代表一个评论线程,并提供包括谁放置了评论以及何时放置、初始评论文本、任何应用的提及/分配以及线程回复数量的摘要信息。

通过在评论和任务面板中选择其条目或在设计空间中点击其关联图钉来打开一个评论线程。这将在文档编辑器中突出显示评论,并打开评论条目对话框,其中包括发起评论和任何用户回复。如果选定的评论与另一个设计文档相关联,系统将打开(并在必要时加载)该文档。

通过在设计空间中选择图钉标记,并在评论和任务面板中选择条目来导航评论。

评论对话框

与放置的评论进行交互是通过弹出的评论对话框进行的,该对话框显示所选评论线程中的所有条目,并包括预览、回复、编辑、解决和删除条目的选项。当最初放置评论时,或者当在评论和任务面板或设计空间中选择了放置的评论时,会打开对话框。按Esc或点击设计空间以关闭评论对话框。

您可以使用对话框标题中的上一个/下一个按钮()来依次浏览所有可用的评论。

预览

在初始评论中选择原始快照选项,以查看放置评论时编辑区域的图形捕获。点击右上角的图标或截图本身以打开全尺寸预览(点击此预览右上角的图标或图像本身以关闭它)。

回复

回复字段中输入文本,并可选择添加用户提及('@'),以在评论线程中添加新条目。选择分配任务给选项,以创建分配给下拉菜单中指定用户的任务。点击以确认条目。

编辑和删除

可以通过评论的菜单中的编辑选项,由该评论的作者编辑现有评论。点击按钮以确认评论编辑。

使用删除选项来移除当前选中的评论。请注意,如果删除的是初始评论(而不是回复),则整个线程将被移除。

使用转换为任务选项将评论转换为分配给自己的任务。

使用复制链接选项复制评论线程的URL。此链接可用于在工作区浏览器界面的Web 查看器中打开此项目,并将评论的对象、点或区域缩放并居中。

解决

点击对话框的 / 按钮,以在已解决未解决(默认)之间切换评论状态。已解决的评论(标记为完成)是不活动的且不可编辑的, 其在评论和任务面板中的条目及其在文档上的图钉标记都会变灰。

设置任务优先级和状态

如果任务评论已分配给用户,可以设置其优先级和状态。任务最初立即设置为中等优先级和待办状态,但可以通过点击评论对话框顶部的相关控件来更改。

待办事项面板

虽然您的连接工作区提供了上述评论和任务分配的全面功能集,但您也可以访问待办事项面板来跟踪您的任务。待办事项面板列出了当前为活动项目定义的所有待办事项。待办事项用作提醒,用于在与文档相关的后期阶段需要执行的任务。

待办事项面板
待办事项面板

要访问面板,必须启用UI.PanelToDoList 首选项名称字段,在高级设置对话框中默认是禁用的。可以通过点击系统 - 通用页面上的高级按钮来访问高级设置对话框,在首选项对话框中。如果在高级设置对话框中进行了任何更改,必须重新启动软件才能使更改生效。
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.

您可以使用的功能取决于您的 Altium 订阅级别。如果您在软件中找不到某个功能,请联系 Altium 的销售人员以获取更多信息。

Content