用phpDocumentor解析Javascript文件

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

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

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

我能想到的应该发生的网络服务器是安装到服务器.js文件通过PHP的问题。任何人都可以想到其他问题吗？有没有更好的方法来实现这一点？

感谢

来源

2009-11-22 ncatnow

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

来源

2009-11-22 13:23:58 ashnazg

我觉得这是一个有点天真地认为有对JavaScript没有类似的工具。

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

更新周五，2015年5月1日 -

它看起来像新的项目链接： -

https://github.com/jsdoc3/jsdoc

来源

2009-11-22 10:51:34

我也不知道JSDoc。不过，我可以看到@ncatnow的观点：在一个地方和布局上生成文档，而不是必须使用两种解决方案和两种不同语言的两种设置，这将是lovley。至少对于单一功能的Javascript，这应该是可能的，不是吗？ - – 2009-11-22 10:59:56

也许试试Doxygen？它类似于PHPDoc，也支持PHP和afaik JavaScript。尽管我自己并没有使用它。 – 2009-11-22 11:31:11

@Jani Hartikainen：我认为我认为我还没有研究过这个问题有点天真。我看了一下JSDoc，但是当我想要的只是将几个JS文件包含在当前文档集中时，它有点超过了顶层，并带有一些简单的'phpdoc'，它允许我设置一些todo项目，将其打包，等等。 Pekka是对的钱。正如我所说 - 从文档生成的角度来看，我已经有了这个工作。我很想知道其他人是否已经做到了这一点，并且使它的工作方式超过了我。 – ncatnow 2009-11-22 12:53:13

我在找同样的东西。我找到了JSDoc和PhpDocumentor，但考虑到1（ONE）应用程序作为“整体”包含PHP和JavaScript作为应用程序的基础，我更愿意使用1种方法来记录项目。它真的很糟糕，有2个文档集，1个用于php，1个用于JavaScript。那个ole @see或inline @link在下列情况下不起作用：@通过其他文档程序查看这个其他函数/类在这个其他语言中......让我的漂移？

来源

2011-11-08 01:38:47

用phpDocumentor解析Javascript文件

回答

相关问题