问题标签 [phpdoc]

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 回答
456 浏览

php - php文档。Eclipse中变量的参数化

我听说 Eclipse 不支持这样的变量参数化:

/**

@var DBProxy

*/

$proxy;

或者

/**

@var Uri

*/

$uri = Registry::get('uri');

$uri->...

但没有可用的完成

还有其他解决方案吗?

0 投票
1 回答
413 浏览

php - 如何使 phpDoc 注释在 Eclipse 中可见

我想知道如何在项目范围内使 PHPDoc 注释在 Eclipse 中可见。目前,它仅适用于当前打开的文件。

如果能够在函数自己的文件之外检查我在每个函数之前放入的所有@params 和描述,那就太好了。

非常感谢!

0 投票
1 回答
1039 浏览

php - 如何在 phpDoc/javaDoc 中记录访问器/修改器方法?

给定一个函数,该函数的行为取决于传递给它的参数,它既可以是 mutator 也可以是 accessor,如下所示:

您如何在 PHPDoc 或类似的自动文档创建器中记录这些内容?我最初只是这样写的:

但是,当它通过 phpDoc 运行时,它会报错,因为有 2 个返回标签,并且第一个@param $cacheName描述被第二个覆盖。

有没有解决的办法?

0 投票
2 回答
758 浏览

php - 从 NetBeans 6.8 项目生成 PHP 文档

有没有办法在 Netbeans 6.8 中为 PHP 项目生成 PHPDoc 文档?

0 投票
2 回答
2606 浏览

php - NetBeans 中的“无建议”

几天来,我正在使用 NetBeans 6.8 进行 PHP 工作。但是即使包含一个类文件并且方法是公共的并且使用了 phpDoc,NetBeans 每次都会在窗口中显示“No Suggestions”。

例如我输入

并按 CTRL+空格键,我确实希望所有方法和变量,但没有显示任何。想法?

0 投票
2 回答
841 浏览

php - 如何在 NetBeans 中获取包含文件的建议

我在获取包含在包含文件中的类的建议时遇到问题。

例如,文件 'Header.php' 的内容是:

当我现在在我的文件“Example.php”中包含 Header.php 时,我没有得到任何建议:

输入 User:: 后,我将 User 类的 Method 和 Vars 作为建议,但没有任何建议。如果我将“User.php”直接包含在“Example.php”中,它可以工作,但这对我没有帮助。如何解决这个问题呢?

0 投票
4 回答
3987 浏览

php - PHP 中有一个好的(独立的)PHPDoc 解析器类或函数吗?

我正在寻找一些将 PHP Docblock(用于通过Doxygen等工具生成文档)转换为我可以在 PHP 中检查的结构的方法。

例如,我想解析

类似于:

我明确不能使用 PEAR或任何此类库,它必须是相对独立的。任何给定的解决方案都比在剥离注释大纲后使用一堆正则表达式更好。

0 投票
1 回答
267 浏览

phpdoc - 将 phpdoc 与现有 docbook 相结合

我想将一些 phpdoc 生成的文档包含在我已经存在的 docbook 文档中。

我的想法是让 phpdoc 生成 docbook 格式的文档,然后使用 XInclude 导入它的部分(基于包和子包)。我正在使用 Docbook 5 作为我的文档。有什么办法可以做到这一点?


到目前为止,我尝试的是使用XML:DocBook/peardoc2:defaultphpdoc 参数生成文档手册。

PHPDocumentor 的文档分为几个文件 - 很好,但文件看起来像这样

据我了解,这些是外部实体,但需要在 DTD 中引用它们 - 使它们对我的工作毫无用处,因为 phpdoc 没有生成 DTD,我不想为每个类和方法都包含一个文件用手。

0 投票
1 回答
976 浏览

php - 如何在 PHP (Java)Doc 中标记数组值类型?

这可能有点难以解释,所以我将给出一些示例代码。请注意,我使用的是 NetBeans IDE(最新)。

在 netbeans 中开发时,我可以在键入“$s->”后按 ctrl+空格来调用自动完成功能。在随后的提示窗口中,有“say()”项。这是因为 javadoc 说 say_something 返回一个 Dummy 和 NetBeans 解析的 Dummy 类,以知道它有一个名为“say()”的方法。

到目前为止,一切都很好。

我的问题是数组。示例代码如下:

如果我再次尝试自动完成,但使用 "$s[0]->" 代替,我不会从 Dummy 类中获得方法。这是因为在 JavaDoc 中我只说它是一个数组,而不是值的类型

所以问题是,是否有任何 JavaDoc 语法、作弊或任何允许我告诉 JavaDoc 在数组中期望什么类型的变量?

0 投票
1 回答
234 浏览

php - WordPress 代码遵循什么类型的文档?

我正在尝试开始使用某种标准来记录我的 PHP 代码。我的大部分代码都是 WordPress 插件的形式,有些变得相当复杂,我需要记录下来。

所以我的问题很简单,WordPress 使用什么系统来记录他们的代码?