使用 phpDocumentor 解析 Javascript 文件答案

【问题标题】：Parsing Javascript files with phpDocumentor使用 phpDocumentor 解析 Javascript 文件
【发布时间】：2009-11-22 10:39:42
【问题描述】：

我最近一直在使用 phpDocumentor，发现它非常适合我的需求。我主要使用 PHP/HTML/JS/CSS 代码库，并希望 phpDocumentor 解析我的 Javascript（可能还有 CSS），以便将它们保持在一起。

我已经设法让 phpdoc 解析整个代码库中包含的 javascript 文件 - 但是它拒绝页面级 docblock - 这导致它拒绝各种标签（见下文）。我发现通过在 JavaScript 文件的顶部添加一个 PHP 打开标记（前面带有 JavaScript 注释），我可以让它像解析 PHP 文件一样解析它。

// <?php
/**
 * phpdoc goes here
 * @package
 * @todo
 *   - Todo 1
 *   - Todo 2
 */
function javascript(goes, here) {
}

如果通过 PHP 将网络服务器设置为服务器 .js 文件，我可以想到会出现问题。还有其他任何人可以想到的问题吗？有没有更好的方法来实现这一点？

谢谢

【问题讨论】：

标签： javascript parsing phpdoc

【解决方案1】：

我认为认为没有类似的 JavaScript 工具有点幼稚。

有一个名为JSDoc的工具，它与phpdoc基本相同，但用于JavaScript。

2015 年 5 月 1 日星期五更新：-

新项目链接好像是：-

https://github.com/jsdoc3/jsdoc

【讨论】：

我也不知道 JSDoc。不过，我看到了@ncatnow 的观点：在一个地方和布局上生成文档，而不是必须使用两种不同语言的两种设置的两种解决方案，这将是 lovley。至少对于纯功能性的 Javascript 这应该是可能的，不是吗？ ——
也许可以试试 Doxygen？它类似于 PHPDoc，也支持 PHP 和 afaik JavaScript。不过自己没用过。
@Jani Hartikainen：我认为认为我还没有研究过这个有点天真。我查看了 JSDoc，但是当我只想在当前的文档集中包含几个 JS 文件时，它有点过头了，带有一些简单的“phpdoc”，这将允许我设置一些待办事项，打包它，等等。佩卡是对的。正如我所说 - 从文档生成的角度来看，我已经有了这个工作。我很想知道其他人是否曾经这样做过，并使其以比我更出色的方式工作。

【解决方案2】：

至于潜在的问题，我想到的一个问题是，由于您“欺骗”phpDocumentor 解析文档块和 JS 代码，因此您隐含地依赖 PHP 标记器 (这就是 phpDocumentor 在内部解析 PHP 代码的方式）以成功读取您的 JS 代码并将其视为 PHP 代码。当这成功时，我认为你会有很好的结果......你的简单函数示例应该会成功。但是，如果您的 JS 代码不会成功解析为 PHP 代码，那么我敢打赌 phpDocumentor 不会将其视为可文档化的代码元素，因此它不会出现在您的文档中。

【讨论】：

【解决方案3】：

我正在寻找同样的东西。我找到了 JSDoc 和 PhpDocumentor，但考虑到 1 (ONE) 应用程序作为一个“整体”包含 PHP 和 JavaScript 作为应用程序的基础，我更喜欢用一种方法来记录项目。拥有 2 个文档集真的很糟糕，1 个用于 php，1 个用于 JavaScript。 ole @see 或内联 @link 在 @see 这个其他语言中的其他函数/类的情况下不起作用，通过其他一些文档程序......明白我的意思吗？

【讨论】：