2

PhpDocumntorによると、有効なドキュメントに変換するためのコメントの各ブロックは、次のようにカプセル化する必要があります。

/**
* This function is used blah, blah, blah
* line 2
* line 2
* ...
*/
function MyFunc($string) {...

各行の前にアスタリスクを強制的に配置することを回避することが可能かどうか（おそらくいくつかの設定を変更することによって）知っていますか。基本的に、PhpDocumentorにこれらのタイプのコメントを受け入れて、ドキュメントに翻訳してもらいたいと思います。

/**
This function is used blah, blah, blah
line 2
line 2
...
*/
function MyFunc($string) {...

JsDOCとJavaDocは、新しい行の前にアスタリスクを付ける必要がなくなったので、PhpDocumentorも設定を少し工夫することでこれを実行できると思いましたが、Googleではこれについて何も見つかりません。 。

4

3 に答える 3

1

たぶん、アスタリスクを配置するエディターを使用する必要があるので、手動で行う必要はありません。PHPをサポートする多くのプログラマーのエディターと同様に、ほとんどすべてのPHP互換IDEがそれを実行します。

このようにアスタリスクを使用するのが標準的な規則です。あなたのコードが洞窟の中に隠されて、誰もそれを見ることができない大量のセメントの下に隠されない限り、標準的な慣習に従うのは良い考えかもしれません。

于 2010-09-09T19:36:52.020 に答える
0

PhpDocがドキュメント/オートコンプリート情報を作成する方法を変更した場合、エンドユーザーがドキュメント/オートコンプリート情報を使用してコードを表示したい場合は、設定も変更する必要があることを覚えておく必要があります。

PhpDocでこのオプションを認識していませんが、DocBlockテンプレートで遊んでみることができます。

これは、ドキュメントブロックテンプレートの操作に関するリンクです。

于 2010-09-09T18:07:16.537 に答える
0

PhpDocumentorを使用してそれを行う方法はありません。

PhpDocumentorをあきらめて、Doxygenを使い始めました。興味があるかもしれない人のために、Doxygenは最終ユーザーがJavaDocやJsDocのような多くの方法でPHP関数を文書化することを可能にします。また、ドキュメントの各行の先頭に「いまいましい」アスタリスクを付ける必要はないので、次のコメントは問題なく、Doxygenによって適切に解析されます。

/**
... line1 ...
... line2 ...
*/
function MyFunc($string) {...
于 2010-09-13T16:07:37.633 に答える