问题标签 [phpdoc]

我正在为我的源代码使用 PHPDoc 和 JSDoc。我知道有一些工具可以从这些文档中构建 API。但是，我想知道的是，应该如何解释复杂的代码？我是否只是在函数中使用多行注释而不是在 PHPDoc/JSDoc 中进行解释？

例如，考虑以下代码：

在上述情况下，我应该如何去注释复杂的代码？我认为我不能在 JSDoc 中做到这一点，因为它用于构建 API（这是关于“如何使用”而不是“事情如何工作”），对吧？

我的假设是否正确：

• JSDoc/PHPDoc 是专门为那些将要使用函数/方法的人编写的。
• 函数中的注释是为需要了解函数/方法背后逻辑的任何人编写的。
• 文档与 API 和源代码注释是分开的，文档（每个软件都应该提供）是为那些想要使用该软件的人编写的。

但我不明白的是，在架构层面解释软件的内容——是否也应该有开发人员文档？

您完善文档的策略是什么？

假设我有一个这样的评论块：

当我在这个块内打开一个新行时，我希望 vim 开始它

但是标准（ubuntu）vim脚本中的自动缩进开始一个空行，如下所示：

是否有修改后的脚本或命令可以让 vim 做到这一点（我记得几年前我有这个功能，但现在不能用谷歌搜索）？

TIA。

我有一个基类（我们称之为 A），我有继承类（我们称之为 AA）。
在另一个抽象类中，我有：

在一个更不同的类中：

我的问题是当我在继承类中ctrl+左键单击时MyA，它会将我带到原来的A类文件。我希望它带我去AA档案馆。
这样做的 PHPdoc 方法是什么？

我正在寻找将 PHPDocumentor 输出转换为我可以在 PHP 中遍历的格式（理想情况下，我想要一个包含所有函数及其注释的数组）。

有没有办法做到这一点？

我听说你可以使用 phpDoc 来帮助 IDE 自动完成。有人可以展示如何将它与 Doctrine 一起使用吗？例如，我有一个 JobTable 类，它用一堆方法扩展了 Doctrine_Table 并且希望在我输入时自动完成： Doctrine::getTable('Job')-> ... 有可能吗？有没有办法在没有 phpDoc 的情况下做到这一点？

我按照 MVC 模式在 Codeigniter 中开发了一个项目。

这意味着，例如，我有一个名为 Items 的控制器，它调用一个名为 Items_model 的模型，它从数据库中获取文件，最后将这些文件传递给一个名为 Item_view 的视图。

现在我需要记录它，并且我正在尝试使用 phpdoc。

我的主要问题是如何在控制器中对函数的解释中，以函数的方式将该函数的行为与模型和视图联系起来，而不仅仅是用纯文本编写名称。我正在阅读有关软件包的信息，但不知道如何正确使用它

我希望你能帮忙，我对 phpdoc 很菜鸟。

提前感谢，对不起我的英语。

斯维尔德。

我使用 NetBeans 作为我的 php ide，我在 docblock 中看到了如下所示的 @version 标签：

NetBeans 是否有办法在每次提交时自动更新它？还是我完全错过了这个标签的重点？

如何记录可变数量的参数？我正在用 PHP 和 JavaScript 编写应用程序。目前我有（在 JavaScript 中）：

那么，我如何记录 n 个字符串参数？

用 phpdoc 记录修改受保护属性的方法的最佳方法是什么？

例如，记录下面的 setVar() 方法的正确方法是什么？

提前致谢，

.L.

我正在使用 PHP 的 Codeigniter 框架。我想知道是否有一种方法可以使用 PHPDoc @property 在模型中加载方法以进行自动完成。

我的意思是 ....

我在处理 Cakephp 时使用 NetBeans 做了类似的事情。我想知道 CodeIgniter 是否也可以这样做/

问候