2016-08-10 6 views
0

phpDocはカスタムタグをサポートしていますか? @untestedを使用して、まだテストされていないコードをマークしたいと思います。これはどうすればできますか?phpDocでカスタムタグを使用できますか?

あなただけ

/** 
    * Here comes the summary 
    * 
    * @todo this code has to be tested 
    * 
    * @return boolean Returns something 
    */ 
function someFunction() 
{ 
    <...> 
} 

よう@todoタグを使用していないか、この情報があなたのドキュメントに含まれてしたくない場合、あなたはこのようにインライン@internalタグを使用することができますなぜ

+1

Googleで検索しましたか? https://onomatopoeia.pinkgothic.com/article/extending-phpdocumentor-with-custom-tags – rokas

+0

@rokas 2009年の記事に感謝します。 phpDocは、コードを入れたりコードを変更することなく、タグをサポートしていないようです。 –

答えて

2

/** 
    * Here comes the summary 
    * 
    * {@internal this code has to be tested }} 
    * 
    * @return boolean Returns something 
    */ 
function someFunction() 
{ 
    <...> 
} 

カスタムタグを追加することをお勧めします。 PHPDocはまだ非公式ですが、近い将来正式な標準になる可能性があります。だから、もし私があなただったら、可能な限り公式のタグをつけておきます。

関連する問題