클래스의 설명을 사용하기위한 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은 docblocks에 대해 아무 말도하지 않습니다. 당신이 파일에 대한 설명을 가지고 있지만, 정확한 클래스 MyClass 댓글이없는 것

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

namespace MyNamespace; 

class MyClass 
{ 
} 

가 처리됩니다 정말 중요한 무엇

귀하의 의견은 phpdoc에 의해 처리되는 방식입니다 그래서 문서를 생성 한 후에는 클래스 설명이 없다는 오류가 발생합니다. 두 번째 경우

:

<?php 

namespace MyNamespace; 

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

class MyClass 
{ 
} 

phpdoc이 클래스Myclass에 주석으로 docblock 생각하지만, 전체 파일에 언급 찾을 수 없습니다. 따라서 문서를 생성 한 후에도 오류가 발생합니다.

그러나이 두 가지 방법을 사용하면 클래스 설명, 파일 설명이 더 좋기 때문에 두 번째를 선택합니다.