- 查看内联文档
- 基础
- 查看快速文档
- 快速文档查找工具栏
- 另请参阅:
查看内联文档
在这个页面中:
- 基础
- 查看快速文档
- 快速文档查找工具栏
基础
快速文档查找可帮助您获取任何符号的快速信息或仅仅方法的签名信息,前提是此符号已以适当的格式提供了文档注释。
- 对于标记语言,PhpStorm根据文档类型设置从语言规范中检索参考。
- 有关在JavaScript或PHP环境中检索内联文档的信息,请分别参阅查看JS注释文档和查看PHP注释文档。
- 文档查找也可用于Drupal钩子,请参阅Drupal具体编码帮助。
因此,这些文档在文档工具窗中正确呈现:
在方法的文档注释中指定的URL和电子邮件地址也会正确呈现。单击超链接会在外部浏览器中打开相应的URL;单击电子邮件地址将打开默认邮件客户端。
查看快速文档
要查看插入符处符号的文档,请执行以下操作之一
- 在主菜单,选择View | Quick Documentation Lookup
- 按
Ctrl+Q
- 如果编辑器设置中鼠标移动时显示快速文档复选框被选中,只需将鼠标指针移动到所需的符号上即可。
要更改快速文档的字体大小,请执行以下操作之一
- 单击快速文档窗口右上角的,然后移动滑块。
在按住
Ctrl
键的同时旋转鼠标滚轮。
请注意,要使此功能正常工作,您必须在编辑器设置的常规页面中启用它。更多详细信息,请参阅在编辑器中缩放部分。
快速文档查找工具栏
快速文档查找窗口通过超链接跳转到相关符号,并提供了一个工具栏,用于在已导航的页面之间来回移动,更改字体大小,以及在外部浏览器中查看文档。
当固定时,快速文档查找转为文档工具窗,并具有相应的侧栏图标和更多控件。
图标 | 快捷键 | 描述 |
---|---|---|
Left 或Right |
切换到上一个或下一个文档页面(例如,在使用超链接后)。 注意: 在OS X计算机上,您还可以使用三指右右到左和从左到右滑动手势。 |
|
Shift+F1 |
在默认浏览器中查看外部文档。 | |
F4 |
切换到与当前显示的文档页面对应的项目(例如,资源)。 | |
打开或关闭自动更新源选项。当选项打开时,工具窗口中的信息将与您在编辑器中的导航以及UI中的其他位置同步。 | ||
单击此图标可显示字体大小滑块。根据需要移动滑块以在快速文档窗口中增加或减少字体大小。 |
另请参阅:
规程:
- 创建JS注释文档
- 创建PHP注释文档
- 查看PHP注释文档