4

我最近一直在玩 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 文件，我可以想到会出现问题。还有其他任何人可以想到的问题吗？有没有更好的方法来实现这一点？

谢谢

4

3 回答 3

8

我认为认为 JavaScript 没有类似的工具有点天真。

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

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

似乎新的项目链接是：-

https://github.com/jsdoc3/jsdoc

于 2009-11-22T10:51:34.953 回答
4

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

于 2009-11-22T13:23:58.900 回答
1

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

于 2011-11-08T01:38:47.940 回答