問題タブ [phpdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
php - PHPDocよりも優れたものはありますか?
PHP
同じドキュメント構文を読み取るが、より豊富な出力を提供するツールはありますかPHPDoc?
?
svn - Subversionにコミットするときにスクリプトを実行できますか?
PHPプロジェクトのドキュメントを作成するスクリプトを実行したいと思います。基本的にはwgetを使用してphpdocを実行しています。
php - phpdoc の複数のサブパッケージ
ファイルを複数のサブパッケージに所属させることはできますか? 例えば:
ありがとう!
php - DocBook から DokuWiki へ
docbook コンテンツを取得して DokuWiki コンテンツに変換する簡単な方法はありますか? これまでのところ、docbook のコンテンツを解釈して XHTML で出力するDokuWiki プラグインしか見つけていませんが、これはページが読み込まれるたびに発生します。
docbook のコンテンツを DokuWiki のネイティブの書式設定構文に直接変換する方法を見つけたいので、一度だけ解釈する必要があります。何か案は?
php - オブジェクトの配列を示唆するPHPDocタイプ?
したがって、PHPDocでは、@var
メンバー変数宣言の上にその型を示唆するように指定できます。次に、IDE、たとえば。PHPEdは、処理しているオブジェクトのタイプを認識し、その変数のコードインサイトを提供できるようになります。
これは、後でそれらのオブジェクトを反復処理するときに適切なヒントを取得できるように、オブジェクトの配列に対して同じことを行う必要があるまではうまく機能します。
それで、メンバー変数がSomeObj
sの配列であることを指定するためにPHPDocタグを宣言する方法はありますか?@var
たとえば、配列は十分ではなく、@var array(SomeObj)
有効ではないようです。
php - PHPDoc の冗長性は、価値があるよりも面倒ですか?
今日初めて PHPDoc を使用してみましたが、すぐに問題が発生しました。
変数宣言の 1 行ごとに、少なくとも 5 行のコメントがありました。例:
もちろん、見返りは素晴らしいですが、これにより、10 行の構成ファイルが 60 行のファイルに変わります。記入するのに永遠に時間がかかりますが、単純なワンライナーよりもはるかに多くのことを追加できるとはまだ確信していません.
また、ワークフローにねじれが発生します。大幅な変更が必要になるまでは、すべて問題ありません。ドキュメント ブロックが十分に文書化されているため、突如としてコードをリファクタリングする必要がなくなりましたが、これらの面倒な詳細をすべて書き直す必要があります。あなたが言う最後まで待って?ハッ!その後、文書化は決して起こりません。
その上、コードの途中で C スタイルの /**/ コメントを強制されます。これにより、必要に応じて大きなブロックをコメントアウトする機能が失われるため、開発中に私は夢中になります。コードの大きなブロックをコメントアウトするには、 :range,s/^/#/ のようなものをプルする必要があります。後で元に戻します。迷惑!
簡単に言えば、私はPHPDocが好きで、よく文書化されたコードが大好きですが、コードの1行ごとに5行のコメントは多すぎます! . 不足している機能はありますか? これはよくある問題ですか?
php - PHP Code Diff から、変更されたクラスと関数がわかりますか?
バックグラウンド:
PHPDoc ( http://www.phpdoc.org/ ) は、ファイル内のコメントからクラスまたはメソッドの HTML ドキュメントを抽出するための優れたツールです。PHPDoc コメントを追加すると、他にも利点があります。Zend や Netbeans などの IDE を使用している場合は、PHPDocs を使用してオートコンプリートのヒントが表示されます。
ほとんどの問題トラッカーには、特別なコメントを付けてバージョン管理システムにコミットできる機能があり、そのコミットをその問題に自動的にリンクします。
そこで、私がシステムに求めるものは次のとおりです。特別なコメントを付けていくつかのコードをコミットし、課題トラッカーがそれを課題にリンクします。次に、コミットを見て、どのメソッドとクラスを変更したかを判断します。次に、「この問題に関するドキュメントを探している場合は、PHPDoc のこれらのビットを試してください: ClassX.FunctionY、ClassZ.VariableP」と表示されます。関連する可能性のあるドキュメントにユーザーを自動的に誘導します。これは素晴らしい機能になると思います。
質問:
したがって、欠落している部分は、PHP コードの diff を取得して、どのクラスとメソッドが変更されたかを調べるものです。誰かがそれを行うことができるいくつかのコードについてのポインタを持っていますか?
前もって感謝します、ジェームズ
php - PEAR 経由で OSX にインストールされた PhpDocumentor が機能しない - ファイルが見つからない?
私は基本的に PEAR (および PhpDocumentor) の初心者です。PEAR CLI を使用して PhpDocumentor をインストールしましたが、すべてうまくいったように見えました...使用するまでは、次のエラーが発生しました。
エラーについてオンラインで何も見つけられなかったので、エラーなしでコマンドラインからアンインストール/再インストールしましたが、同じ問題が発生しています。私は何かを見落としましたか?私が言ったように、私は PEAR にまったく慣れていません :)
ありがとう。D