2

だから、私はSilexマイクロフレームワークを使って作業していて、クロージャーを文書化する正しいPHPDocの方法に興味があります。

require_once __DIR__.'/silex.phar'; 

$app = new Silex\Application(); 

$app->get('/hello/{name}', function($name) use($app) { 
    return 'Hello '.$app->escape($name); 
}); 

$app->run();

GETクロージャーを文書化するにはどうすればよいですか？

4

1 に答える 1

0

その閉鎖に関してあなたがあなたの文書の読者に言いたいことは何ですか？それが存在することを強調しますか、それともクロージャーが使用しているSilex \ Application-> escape（）メソッドへの@uses <-> @ usedbyドキュメントリンクを作成しますか？

クロージャーを文書化するためのPHPDoc構文が（まだ）存在することを私は知りませんが、APIコンテキストでコンシューマーが実際に使用できないことを考えると、それを文書化するユースケースがあるかどうかはわかりません。 。まあ、コードを読むドキュメントリーダーに詳細を提供することは別として。後者の場合は、おそらく@internalタグを使用して、読者に認識してもらいたいクロージャーに関するメモを記述します。さらに、そのコードスニペットに「文書化可能な要素」がないことを考えると、その@internalタグをファイルレベルのdocblockに配置する必要があります。

于 2012-05-23T15:51:27.707 に答える