问题标签 [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 回答
1184 浏览

php - NetBeans IDE 中 phpDocumentor 中的特殊 HTML 字符

如您所知,NetBeans IDE 将根据 phpDocumentor 语法在您的 PHP 源代码中弹出内联文档。

我发现当我在 phpDocumentor 文档中使用特殊的 HTML 字符时,它们在 NetBeans 中被视为 HTML,但在 phpDocumentor 生成的 HTMl 文档中被视为文本。

例如:

在 phpDocumentor 生成的 HTML 中,会显示为:

但在 NetBeans IDE 中,它将显示为:

哪一个是对的?在 phpDocumentor 注释中嵌入特殊 HTML 字符的正确方法是什么?

0 投票
5 回答
5298 浏览

php - 是否有支持 PHP 5.3 的 PHPDocumentor 替代品?

一些新的 PHP 5.3 特性,包括名称空间和匿名函数,与 PHPDocumentor 不兼容,即使是最新版本也是如此。例如,它只是在遇到“没有名称的函数”时引发错误,即闭包。那么,是否有任何其他开源工具可以从 PHP 5.3 代码中的 Javadoc 样式注释生成 API 文档(最好是 HTML 文档)?

0 投票
2 回答
8319 浏览

eclipse - 在 Eclipse 中用 subversion 填充 @version 标签

我想在 Eclipse 中用 Subclipse 或 Subversion 填充评论标签@version。CVS 已经自动完成了这项工作,但 Subversion 没有。这将非常有帮助。

我试图用谷歌搜索“@version”,但这似乎是不可能的。

CVS 所做的示例:

SVN 示例:

请帮忙.....

0 投票
2 回答
9494 浏览

php - 如何在 Eclipse 中使用 PHPdoc

我们目前正处于一个新项目的开始阶段,并希望(一次)从一开始就尽可能多地发表评论,以帮助未来的发展。

我试图找出在 Eclipse 中使用 phpDoc 的最佳实践,但结果相当渺茫。

您能否分享您在 Eclipse 中使用 phpDoc 注释内容的最佳实践和技巧?

0 投票
2 回答
904 浏览

php - PHP 文档标签是什么意思:#@+ 和 #@-

我在 Zend 框架中找到了这个:

这些是“打开”和“关闭”标签吗?它们受 phpdoc 支持吗?我找不到任何有关它的文档(并且无法通过谷歌搜索)

谢谢你。

0 投票
3 回答
964 浏览

eclipse - 将 $this 链接到 Aptana 中特定类的 phpdoc 语法是什么?

我正在研究 Magento 模板,但这个问题适用于任何模板加载系统。

由于这些模板是由模板引擎加载的,IDE(在本例中为 Aptana)无法知道 $this 是什么对象类型。

潜在地,它可能不止一个对象,因为单个模板可以被多个对象加载,但忽略这一点,正确的 phpdoc 语法是为 $this 对象指定特定类?

0 投票
1 回答
878 浏览

php - 简单的纲要,全面的 phpDocumentor 教程?

我发现网站上提供的一个对于新手来说非常难以承受。有没有更好的教程,它会慢一点,而不是向你扔 3 个长的 php 源文件?

编辑:

除了说明书真的没有别的了吗???丁:

0 投票
1 回答
406 浏览

php - 在 PhpDocumentor 中,有没有办法指定默认版本号?

我正在记录的代码库中的所有文件将始终使用相同的版本“字符串”有没有一种方法可以在一个地方指定 PhpDocumentor 对所有文件使用相同的版本,无论是否指定(应该自动继承)

...还有哪些其他标签对您的头脑有用?

编辑:

有什么可以绕开亲子关系的?用于读取版本、作者、版权的 .ini 或配置文件之类的东西?

0 投票
1 回答
195 浏览

php - 任何机构都可以帮助拆分php源代码

任何人都可以帮助我分离这个我需要解析和分离文本的数据示例,就像 PHPDoc 一样。它是 PHP 源代码。

示例字符串:

任何人都可以帮助我如何根据“功能”字分离上面的字符串并创建和数组。谢谢

0 投票
2 回答
704 浏览

php - 记录 PHP,如果我扩展一个类,我应该复制/粘贴吗?

我有一个带有方法的 PHP 类。在基类中(它更像一个原型,但我没有使用原型,因为我们必须向后兼容),我记录了方法的参数和描述。

现在我扩展了那个类。在这个新方法(实现)中,我应该重新记录参数和描述,我应该将其留空,还是应该只留下适用于该特定实现的相关注释?

我的目标是拥有由 PhpDoc 生成的可读 API 文档,并遵循约定。