Question

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

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

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

如果通过PHP将Web服务器设置为服务器.js文件，我可以想到会出现问题。有没有人能想到的其他问题？有没有更好的方法来实现这一目标？

由于

Answer 1

我认为认为没有类似JavaScript的工具是一种天真的假设。

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

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

似乎新项目链接是： -

https://github.com/jsdoc3/jsdoc

Answer 2

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

Answer 3

我正在寻找同样的事情。我找到了JSDoc和PhpDocumentor，但考虑到1（ONE）应用程序作为“整体”包含PHP和JavaScript作为应用程序的基础这一事实我更喜欢1种方法来记录项目。拥有2个文档集非常糟糕，1个用于php，1个用于JavaScript。那个ole @see或inline @link不适用于@，通过其他文档程序来查看这个其他语言中的其他函数/类....让我的漂移？

使用phpDocumentor解析Javascript文件

3 个答案: