管理任务和上下文
处理项目时,您可以将工作组织成需要完成的较小任务。
这些可以是您自己设定的任务。在 PhpStorm 中,您可以将一大块工作分成更小的任务,并将它们与变更列表相关联。
这些也可以是来自您的问题跟踪器的任务。例如,您可以处理直接从 PhpStorm 分配给您的任务和错误。为此,请连接 IDE 和您的跟踪器帐户。
配置与问题跟踪器的集成
PhpStorm 支持与以下组件的集成:
将 IDE 连接到您的跟踪器
在设置/首选项对话框Ctrl+Alt+S中,选择 。
单击并从列表中选择必要的问题跟踪器。
输入连接详细信息。请注意,设置因您的问题跟踪器而异。
通常,您必须指定服务器 URL 和连接凭据:用户名和密码。
在某些情况下,您需要输入 API 令牌而不是密码。例如,如果您将 IDE 连接到 YouTrack,则Password字段将替换为Token。有关详细信息,请参阅管理永久令牌。
选择共享 URL选项以允许团队的其他成员访问服务器。启用此选项后,服务器 URL 及其类型将保存到.idea/misc.xml文件中,可以通过版本控制在开发团队成员之间共享。
如果要通过代理服务器访问服务器,请单击代理设置。您可以在HTTP 代理部分找到有关代理设置的更多信息。
在Commit Message选项卡上,您可以启用为更改列表添加提交消息并配置消息模板。
在服务器配置选项卡上,配置用于连接到问题跟踪器的高级参数。
此选项卡仅适用于某些跟踪器(例如,不支持开箱即用的跟踪器)。
服务器配置选项卡参数
物品 | 描述 |
---|---|
登录网址 | 用于身份验证的资源。IDE 每次从服务器检索问题列表之前都会向该资源发送请求,例如:{serverUrl}/rest/user/login?login={username}&password={password}。 如果您选择了常规选项卡上的使用 HTTP 身份验证复选框,则该字段将被禁用。 |
任务列表 URL | 用于从服务器检索问题列表的资源,例如:{serverUrl}/rest/api/2/search。 |
单个任务 URL | 通过 ID 检索有关问题的详细信息的资源,例如:{serverUrl}/rest/api/2/issue/{id}。 此字段是可选的,除非您选中了单独请求中的每个任务复选框。 |
获取或发布 | 选择必要的 HTTP 请求类型。 |
单独请求中的每个任务 | 启用此选项允许 IDE 发送多个请求,以便首先检索带有其 ID 的问题列表,然后使用Single Task URL字段中指定的资源分别获取有关每个问题的详细信息。 此选项适用于无法在单个响应中发送所有必需信息的受限 REST API 的问题跟踪器。 |
响应类型 | 选择问题跟踪器响应的格式:XML表示 XPath,JSON表示JSONPath或Text表示正则表达式。 |
选择器表 | 选择器允许您指定将从服务器响应中检索的有关问题的哪些信息。 |
任务 | 服务器响应中问题列表的路径。此字段是必填字段。 |
ID | 服务器响应中问题 ID 的路径。此字段是必填字段。 |
概括 | 服务器响应中问题标题的路径。此字段是必填字段。 |
指定其他集成选项
在设置/首选项对话框Ctrl+Alt+S中,选择 。
配置必要的选项:
变更列表名称格式:当您打开或创建新任务时,PhpStorm会提示您创建与该任务关联的新变更列表。在此字段中,您可以指定将用于为新更改列表生成名称的模板。
单击以从列表中选择占位符。
功能分支名称格式:当您创建或打开一个新任务时,PhpStorm 会提示您创建一个新的功能分支。在此字段中,您可以配置生成新功能分支名称的模板。
单击以从列表中选择占位符。
使用小写和替换空格选项来配置提示的功能分支名称。
如果您的 IDE 与问题跟踪器集成,这些设置很有用。例如,DSGN-0001 添加新图标任务名称将转换为dsgn-0001add-new-icon功能分支名称。
任务历史长度:PhpStorm 存储的任务数。
在提交时保存上下文:每次提交更改时,PhpStorm 都会创建一个新的封闭本地任务,以保存您使用过的文件、书签和断点。这样,您可以在以后的任何时间快速恢复与任务关联的所有选项卡。
启用问题缓存:优化 PhpStorm 和问题跟踪器之间的同步。如果您使用“慢”问题跟踪系统,则特别推荐同步。
PhpStorm 缓存从跟踪器加载的问题列表并重复更新它们。您可以指定应该缓存多少问题以及 PhpStorm 应该多久更新一次有关它们的信息。
任务
在 PhpStorm 中,有两种类型的任务:
从问题跟踪器加载到 PhpStorm 的任务。这些是跟踪任务。跟踪器任务与问题跟踪器中的相应问题相关联。这使您可以直接从 PhpStorm 监视和更新它们。
最初在 PhpStorm 中创建的任务。这些是本地任务。本地任务与问题跟踪器无关。
如果您至少创建了任一类型的任务,则工具栏上会出现一个称为任务组合的列表。
打开跟踪器任务
一旦您将其连接到问题跟踪器,跟踪器任务就会加载到您的 PhpStorm。
从主菜单中,选择
Alt+Shift+N,或单击工具栏上的任务组合。从列表中选择必要的任务。
在“打开任务”对话框中,您可以更新问题状态。
如果要关闭当前在编辑器中打开的所有选项卡,请选中清除当前上下文复选框。
在VCS 操作部分,您可以创建一个新的更改列表,选择一个您想要贡献的现有分支,或者创建一个新分支。
您还可以搁置当前的更改,以便稍后返回。
创建本地任务
在 PhpStorm 中,您可以创建并非源自问题跟踪器的本地任务。
从主菜单中,选择
。您也可以使用任务组合或按Alt+Shift+N。在输入任务名称对话框中,选择创建新任务。
输入新任务的名称。
如果要关闭当前在编辑器中打开的所有选项卡,请选中清除当前上下文复选框。
在VCS 操作部分,您可以创建一个新的 changelist,选择一个您想要贡献的现有分支,或者创建一个新的分支。
您还可以搁置当前的更改,以便稍后返回。
查看任务描述
当您选择要切换到的任务时,任务列表仅显示任务 ID。这些信息并不总是足够的,因为它既不反映导致问题的步骤,也不反映相关的讨论。
转到
。打开必要的任务并按下Ctrl+Q以在 PhpStorm 中打开任务描述,或Alt+Shift+B在浏览器中查看描述。
或者,转到Show 'task ID' Description或Open 'task ID' in Browser。
并单击查看已关闭的任务
如果整个项目或受影响的目录受版本控制,则关闭的本地任务是与更改列表无关的任务。
已关闭的跟踪器任务是在问题跟踪器中具有已关闭状态的任务。
单击任务组合,然后单击打开任务。
选择包括关闭的任务复选框,或按Alt+Shift+N。
关闭任务
转到关闭活动任务。
,然后单击
这将关闭 PhpStorm 中的当前上下文。选择必要的复选框以提交更改,并可选择合并已创建的分支。对于跟踪器任务,您还可以更改它们的状态。新状态将传播到您的问题跟踪器。
删除任务
如果您不需要某个任务出现在 PhpStorm 中,您可以将其从任务列表中删除。
单击主工具栏上的任务组合。
选择要删除的一项或多项任务。
使用Shift(用于相邻项目)或Ctrl(用于非相邻项目)键进行多项选择。
单击右箭头按钮,然后选择删除。
删除跟踪器任务时,会将它们从 IDE 中删除。它们将保留在您的问题跟踪器中。在这种情况下,本地任务将被完全删除,因为它们没有连接到您的问题跟踪器。
时间跟踪
使用 PhpStorm,您可以跟踪在编辑器中工作的任务所花费的时间。对于本地任务,如果您想知道在处理项目时完成一项任务需要多少时间,此信息可能会有所帮助。
对于跟踪器任务,如果您的问题跟踪器配置要求您记录您在任务上花费的时间,则此选项很有用。在这种情况下,您可以将时间日志从 PhpStorm 发送到跟踪器。
启用时间跟踪
按Ctrl+Alt+S打开 IDE 设置并选择工具 | 任务 | 时间跟踪。
选中启用时间跟踪复选框。
(可选)更改暂停延迟值。
在这里,您可以指定在任务被视为挂起之前您必须保持非活动状态的时间。
追踪时间
单击以进行自动时间记录。
如需手动时间跟踪,请单击。要停止手动时间跟踪,请单击。
将时间日志发送到跟踪器
在Time Tracking工具窗口中单击Post work item to bugtracker 。
指定您要记录的时间间隔,并在必要时添加评论。单击确定。
上下文
上下文是在编辑器中打开的一组书签、断点和选项卡。上下文与任务相关联,但您可以使用上下文而不将它们与特定任务相关联。
拥有单独的上下文可以让您处理几件事情并在它们之间切换而不会混合更改。
保存上下文
从主菜单中,选择
。在Save Context对话框中,输入上下文的名称并单击OK。
将项目添加到现有上下文
从主菜单中,选择
。添加必要的项目(书签或断点)或打开必要的文件并保存上下文:
。
在上下文之间切换
当您在任务之间切换时,IDE 会自动切换相关上下文。但是,如果您使用的上下文与任务无关,您可以手动在它们之间切换。
从主菜单中,选择
。在加载上下文弹出窗口中,从列表中选择必要的上下文。
或者,单击右箭头并选择加载。
清除上下文
要清除当前上下文而不加载另一个上下文,请选择
从主菜单中 Alt+Shift+X,或按。
删除上下文
当任务完成时,或者如果您不再需要上下文,您可以将其删除。
从主菜单中,选择
。在Load Context弹出窗口中,单击右箭头并选择Remove。