クラスの説明を使用するためのPSR

Question

PSRで、クラスと名前空間に関するコメントをどこに置くべきかについては何も言いません。それはクラスまたは名前空間の最初の説明ですか？

<?php 
/** 
* Some description about this class 
* 
* @author  Mr. Anderson 
* @since  06/09/17 
* @package 
* 
*/ 

namespace MyNamespace; 

class MyClass 
{ 
} 

それとも正しくは？

<?php 

namespace MyNamespace; 

/** 
* Some description about this class 
* 
* @author  Mr. Anderson 
* @since  06/09/17 
* @package 
* 
*/ 

class MyClass 
{ 
} 

Answer 1

PSRはこれとは関係ありません。 PSRはdocblockについて何も言わない。あなたのコメントはphpdocによって処理されている方法です本当に重要

：

<?php 
/** 
* Some description about this class 
* 
* @author  Mr. Anderson 
* @since  06/09/17 
* @package 
* 
*/ 

namespace MyNamespace; 

class MyClass 
{ 
} 

はあなたのように扱われているがファイルにコメントを持っているが、正確なクラスMyClassにコメントしていませんしたがって、ドキュメンテーションを生成した後、クラス記述がないというエラーが発生します。第2のケースで

：

<?php 

namespace MyNamespace; 

/** 
* Some description about this class 
* 
* @author  Mr. Anderson 
* @since  06/09/17 
* @package 
* 
*/ 

class MyClass 
{ 
} 

phpdocはクラスMyclassへのコメントとしてのdocblockを検討しますが、完全なファイルにコメントを見つけることができません。したがって、ドキュメントを生成した後もエラーは発生します。

しかし、これらのアプローチの両方で、クラスの説明、次にファイルの説明がある方がよいため、2番目の方法を選択します。