使用phpDocumentor解析Javascript文件

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 标记器（这就是 phpDocumentor 在内部解析 PHP 代码的方式）来成功读取您的 JS 代码并将其视为 PHP 代码。当成功时，我认为你会得到好的结果......你的简单函数示例可能应该成功。但是，如果您的 JS 代码无法成功解析为 PHP 代码，那么我敢打赌 phpDocumentor 不会将其视为可记录的代码元素，因此它不会出现在您的文档中。