4

私は最近phpDocumentorで遊んでいて、それが私のニーズに非常に適していることを発見しました。私は主にPHP/HTML / JS / CSSコードベースを使用しており、すべてをまとめるためにphpDocumentorでJavascript（およびおそらくCSS）を解析したいと考えています。

コードベース全体に含まれているjavascriptファイルを解析するようにphpdocを取得することができましたが、ページレベルのdocblockを拒否するため、さまざまなタグが拒否されます（以下を参照）。JavaScriptファイルの先頭にPHPオープンタグ（前にJavaScriptコメントが付いている）を追加することで、PHPファイルと同じように解析できることがわかりました。

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

WebサーバーがPHPを介してサーバー.jsファイルにセットアップされている場合に発生する問題を考えることができます。誰かが考えることができる他の問題はありますか？これを達成するためのより良い方法はありますか？

ありがとう

4

3 に答える 3

8

JavaScript用の同様のツールがないと考えるのは少し素朴な仮定だと思います。

基本的にphpdocと同じですが、JavaScript用のJSDocというツールがあります。

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つのアプリケーションにPHPとJavaScriptの両方が含まれていることを考えると、アプリケーションのベースとなるため、プロジェクトを文書化するための1つのアプローチをお勧めします。2つのドキュメントセット（1つはphp用、もう1つはJavaScript用）があるのは本当に残念です。そのole@seeまたはinline@linkは、他のドキュメントプログラムを介して、この他の言語でこの他の関数/クラスを@seeする場合には機能しません。

于 2011-11-08T01:38:47.940 に答える