问题标签 [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 投票
3 回答
188 浏览

javadoc - 是否有任何工具可以自动检查 javaDoc(phpDoc 等)的质量?

您知道任何可以运行代码并在 javaDoc 块中查找缺陷的工具吗?(也可以解析其他语言,如 PHP、C# 等)。

0 投票
2 回答
8113 浏览

php - 在netbeans中评论代码?

不久前,我可以使用 netbeans 来评论 php 中的任何代码,如下所示:

我刚刚输入了 /* ENTER 并且 netbeans 给了我上面的那几行。然后当我输入 @ 它给了我所有可用标签(作者、参数等)的完整列表。

我重新安装了我的mac,从那以后它就没有工作了。

有人知道为什么以及如何激活它吗?我只为 php 安装了 netbeans。

0 投票
1 回答
1955 浏览

php - php 中的包的文档?

所以在 PayPal 文件夹中,我有多个类用于使用他们的 API。

我想制作有关如何按顺序使用所有类的文档。所以这是我的问题:

  1. 我如何为他们创建一个包?因为在每个类上面我都使用了 phpdoc 标签@package PayPal。php中的包只是一个文件夹吗?

  2. 我在哪里放置包的文档?有这方面的最佳做法吗?文件夹中名为...的文件?

  3. 如何放置特定于类或包的示例,例如。第 1 步 bla bla,第 2 步 bla bla?谢谢!

0 投票
1 回答
143 浏览

php - OSX 上的 PHP Doc 软件?

我将我的 OSX 用于开发。PHP,现在我需要尝试 PHPDoc,但是如何?sombardy 知道一个软件吗?或者我该怎么做?

我试着看这里http://manual.phpdoc.org/HTMLSmartyConverter/HandS/ric_INSTALL.html但我希望我能找到一个 GUI 软件。:)

坦克的所有帮助。

0 投票
1 回答
1015 浏览

php - PHPDoc 函数更新日志 (@change?)

使用 PHPDoc 记录函数更改的最佳方法是什么?就像是

会很好。但是假设没有@change选择......如果我无论如何都添加它,PHPDoc 会用它做什么?还是有更好/更正确的方法来记录功能更改?

0 投票
3 回答
5791 浏览

php - Documenting PHP multiple inheritance with PhpDoc

I have multiple inheritance like this one: Can I extend a class using more than 1 class in PHP? (let's not discuss this approach itself please) and want my IDE to know about inherited class methods and properties. Is there a way to do it with PhpDoc?

0 投票
3 回答
36391 浏览

php - PHP Documentor 中的注释关联数组

我在我的 PHP 应用程序中使用了几个关联数组,并且我正在使用 PHP 文档器来评论我的源代码。我从来没有真正为数组中的数组指定注释,但现在我需要这样做并且不知道如何。

如何以正确的方式评论这个数组@var并进行@param评论?我可以这样做,但我不知道这是否正确:

但是如何为该@var部分执行此操作?

0 投票
4 回答
3023 浏览

php - phpDocumentor 替代方案消耗更少的内存

好吧,我受够了phpDocumentator。它消耗的内存(1.4 GB)和时间(2.6GHz Core 2 Duo 上 5 分钟)比我愿意提供的要多得多。是否存在一些真正兼容的程序来为 PHP 代码生成文档?

我试过PHPDoctor,它看起来不错,但它缺少一些功能。然而,它可能最接近我迄今为止尝试过的所有解决方案的替代品。

我也尝试过PhpDocGen,但它只是解决了一些 Perl 错误,我懒得研究这些错误。

Doxygen 似乎也不能很好地与我们的资源配合使用。

PS:文档将用于phpMyAdmin ,这里有一些过时的文档。

更新:代码包含很多函数,而不仅仅是对象,Doxygen 最大的问题是什么,因为它无法组织它们。

0 投票
2 回答
5005 浏览

php - 如何使用 PHP 解析 phpDoc 样式的注释块?

请考虑以下代码,我尝试仅解析文件中的第一个 phpDoc 样式注释(不使用任何其他库)(文件内容放入 $data 变量以进行测试):

这几乎可行,除了@todo 之后的所有内容(包括注释bar()块和代码)都被认为是 的值@todo

如何更改我的代码以便只解析第一个注释块(换句话说:解析应该在遇到第一个“*/”后停止?

0 投票
1 回答
1046 浏览

regex - 正则表达式去除 phpdoc 多行注释

我有这个:

我正在寻找一个正则表达式来去除除@token 数据之外的所有数据,因此结果将是:

我现在有这个:

它部分完成了这项工作:它只删除了每行前面的 *。谁能帮我,所以它也去掉 /** 和最后的斜线 /?任何帮助将不胜感激!

PS:例如,如果 commentlbock 将包含类似

那么显然@foo 之后的斜线可能不会被剥离。结果必须是:

我希望那里有一个正则表达式大师:-)