php查看文档,查看内联文档

本文档介绍了如何在IDE中查看和使用快速文档查找功能,包括通过键盘快捷键、鼠标操作来获取符号信息。内容涵盖基础用法、JavaScript和PHP的注释文档查看,以及 Drupal 钩子的文档支持。此外,还详细阐述了快速文档窗口的字体调整、超链接导航和工具栏功能,以及如何在外部浏览器中查看相关文档。
摘要由CSDN通过智能技术生成

# 查看内联文档

在这个页面中:

* [基础](#基础)

* [查看快速文档](#查看快速文档)

* [快速文档查找工具栏](#快速文档查找工具栏)

## 基础

快速文档查找可帮助您获取任何符号的快速信息或仅仅方法的签名信息,前提是此符号已以适当的格式提供了文档注释。

* 对于[标记语言](/如何使用/语言和框架-具体指南/标记语言和样式表/README.md),PhpStorm根据[文档类型](http://en.wikipedia.org/wiki/Document_Type_Declaration)设置从语言规范中检索参考。

* 有关在JavaScript或PHP环境中检索内联文档的信息,请分别参阅[查看JS注释文档](/如何使用/语言和框架-具体指南/JavaScript-具体指南/查看JavaScript参考/查看内联文档.md)和[查看PHP注释文档](/如何使用/语言和框架-具体指南/PHP-具体指南/查看PHP注释文档.md)。

* 文档查找也可用于**Drupal**钩子,请参阅[Drupal具体编码帮助](/如何使用/语言和框架-具体指南/PHP-具体指南/在PhpStorm中使用Drupal/Drupal具体编码帮助.md)。

因此,这些文档在[文档工具窗](/参考/工具窗参考/文档工具窗.md)中正确呈现:

![IDE快速文档查看](http://image.jellychen.cn/uploads/2016/12/web_ide_quick_documentation_lookup.png)

在方法的文档注释中指定的URL和电子邮件地址也会正确呈现。单击超链接会在外部浏览器中打开相应的URL;单击电子邮件地址将打开默认邮件客户端。

![快速定义查看](http://image.jellychen.cn/uploads/2016/12/ruby_quickDefinitionLookupURL.png)

## 查看快速文档

* **要查看插入符处符号的文档,请执行以下操作之一**

* 在主菜单,选择**View | Quick Documentation Lookup**

* 按`Ctrl+Q`

* 如果编辑器设置中**[鼠标移动时显示快速文档](/参考/设置参数对话框/编辑器/常规/README.md#鼠标移动时显示快速文档)**复选框被选中,只需将鼠标指针移动到所需的符号上即可。

* **要更改快速文档的字体大小,请执行以下操作之一**

* 单击快速文档窗口右上角的![显示滑块](http://image.jellychen.cn/uploads/2016/12/show_slider.png),然后移动滑块。

* 在按住`Ctrl`键的同时旋转鼠标滚轮。

请注意,要使此功能正常工作,您必须在编辑器设置的[常规](/参考/设置参数对话框/编辑器/常规/README.md)页面中启用它。

![放大文字](http://image.jellychen.cn/uploads/2016/12/ctrl_mouse_wheel.png)

更多详细信息,请参阅[在编辑器中缩放](/如何使用/常规指南/PhpStorm编辑器/基础编辑规程/在编辑器中缩放.md)部分。

## 快速文档查找工具栏

快速文档查找窗口通过超链接跳转到相关符号,并提供了一个工具栏,用于在已导航的页面之间来回移动,更改字体大小,以及在外部浏览器中查看文档。

当固定时,快速文档查找转为[文档工具窗](/参考/工具窗参考/文档工具窗.md),并具有相应的侧栏图标和更多控件。

|**图标**|**快捷键**|**描述**|

|---|---|

|![返回箭头](http://image.jellychen.cn/uploads/2016/11/arrowBack.png) ![前进箭头](http://image.jellychen.cn/uploads/2016/11/arrowForward.png)|`Left`或`Right`|切换到上一个或下一个文档页面(例如,在使用超链接后)。
**注意:** __在OS X计算机上,您还可以使用三指右右到左和从左到右滑动手势。__|

|![向上箭头](http://image.jellychen.cn/uploads/2016/11/arrowUp.png)|`Shift+F1`|在默认浏览器中查看外部文档。|

|![编辑](http://image.jellychen.cn/uploads/2016/12/edit.png)|`F4`|切换到与当前显示的文档页面对应的项目(例如,资源)。|

|![自动滚动到代码](http://image.jellychen.cn/uploads/2016/12/autoscrollFromSource.png)| |打开或关闭**自动更新源**选项。当选项打开时,工具窗口中的信息将与您在编辑器中的导航以及UI中的其他位置同步。|

|![显示滑块](http://image.jellychen.cn/uploads/2016/12/show_slider.png)| |单击此图标可显示字体大小滑块。根据需要移动滑块以在快速文档窗口中增加或减少字体大小。|

# 另请参阅:

规程:

* [创建JS注释文档](/如何使用/语言和框架-具体指南/JavaScript-具体指南/创建JS注释文档.md)

* [创建PHP注释文档](/如何使用/语言和框架-具体指南/PHP-具体指南/创建PHP注释文档.md)

* [查看PHP注释文档](/如何使用/语言和框架-具体指南/PHP-具体指南/查看PHP注释文档.md)

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值