问题标签 [docblocks]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票
1 回答
3011 浏览

phpstorm - php Storm 自定义文档块

有没有办法自定义 phpstorm 生成 docblocks 的方式?

默认情况下,我希望将未知类型的变量视为字符串。

这是生成docblock的默认方式(使用phpstorm 4.01)

如果可能的话,我想要这个:

0 投票
3 回答
5310 浏览

autocomplete - 如何在 DocBlock 中声明无限/可变参数?

假设我有一个函数(显然是一个微不足道的例子):

现在我知道我可以将其修改为

但有些功能不是一个选项。那么,您将如何使用 docBlock 记录函数的第一个版本,以便 IDE 可以解释它可以接收无限参数?

我见过一些使用的方法:

在 IDE 中看起来像自动完成示例

但这对我来说就像是一个黑客,有没有办法只使用 docBlock 来做到这一点?

0 投票
1 回答
2864 浏览

php - PHP Docblocks - 解释数组

可能重复:
phpDoc 有没有办法将对象数组记录为参数?

我一直在搜索,并查看了 phpDocumentor 文档,但找不到是否有办法正确记录 @param 数组(如声明预期的键/值类型),该数组将被解析并包含在任何生成的文档中。

这会让我相信没有办法做到这一点,我将不得不使用描述。

提前致谢。

0 投票
2 回答
36411 浏览

php - 如何记录 IDE 的魔法(_call 和 _callStatic)方法

在使用 notepad++ 和 sublime 编码多年后,有人建议我尝试使用 PHP IDE。我正在尝试 phpStorm,它看起来不错。代码完成和文档是一个很棒的功能,但在使用魔术方法时对我来说不起作用。是否有办法让 phpStorm 了解魔术方法中发生了什么?

我们的情况是这样的:

神奇的 callStatic 方法允许我们通过构成函数调用的 1 个或多个参数来获取对象集合。

我看到在这些情况下有一个 @method 语句可供使用,但 phpStorm 只选择了这些语句中的第一个。此外,我只能将返回类型设置为混合,因为我希望能够将其设置为调用它的任何类(在我的示例中为 b)。

任何想法或建议将不胜感激,谢谢。

0 投票
1 回答
291 浏览

documentation - DocBlocks:@uses 和 @see 之间的区别

相当直截了当的问题——在编写文档块时,我应该如何确定我是否应该说@uses另一个结构元素,以及何时应该告诉人们@see另一个元素?

我已经做了一些谷歌搜索和一些 SO 搜索,但运气不佳,我能看到的唯一区别是@uses有一个匹配的@used-by标签,而是@see单向的。这是否意味着@uses/@used-by是首选@see还是有更多?

干杯。

0 投票
1 回答
321 浏览

php - PHP Docblock #@+ 含义

php docblock中以下内容的含义是什么:

Zend 框架代码中的一个示例:

我假设它用于对相关项目进行分组,但无法确定。

此外,它的语法也很奇怪——从它生成文档时它是如何翻译的?

0 投票
1 回答
779 浏览

php - Docblocker 创建期间的自动时间戳?

有没有一种方法可以创建一个实时模板,它可以通过在 phpStorm 中按“t”+ TAB 来给出当前时间戳:

我想在创建 DocBlocks 时执行此操作,因为我喜欢跟踪代码中的更改,例如:

那么有没有办法实现这一点?还是我必须使用“查看观看并生成自己的时间戳”方法?

0 投票
2 回答
128 浏览

php - 在 PHP 文件中正确标记作者和项目名称?

我只是想知道什么是最被接受的方式来证明自己并在(最好)文档的开头描述整个包,以便其他查看代码的人有参考?

我想知道答案,因为我正在从事一个 PHP 项目,我相信当它完成后人们会查看源代码。我目前//在一开始就有评论,但似乎缺乏。我见过人们使用块注释并添加 a@author等等,这是公认的语法吗?

谢谢。

0 投票
1 回答
579 浏览

plugins - Sublime Text 2 评论格式支持

Sublime Text 2 可以支持这样的评论吗?

是否有任何插件可以在PHPorJS或中做到这一点CSS
(我确实安装了插件:DocBlockr已经。但它现在不能在 windows7 中工作)

在此处输入图像描述

在此处输入图像描述

segmentfault.com 上的附加帖子(中文)


在下面添加:2013-8-18 20:54:11
图片(从视频中找到,但我也在找这个插件)使用PHP,DocBlockr都不能在我的PC
环境下工作:<br>

0 投票
2 回答
589 浏览

php - 解析函数调用的文档块,而不是函数定义?

我正在尝试在 PHP 文件中的某些函数调用之前获取 docblocks。与通常方法的不同之处在于我不尝试解析函数定义的文档块。

示例文件:

do_function确实出现在我要解析的各种文件的各个地方。我要获取和解析的是前面的文档块,包括函数调用。

反射类不是一个选项,因为文件不包含类,所以我坚持使用以下返回空数组的 RegExp:

我在这里做错了什么?谢谢!