使用 class 描述的 PSR

Question

我在 PSR 中找不到任何关于 class 和命名空间的评论应该放在哪里的说法。是先描述class还是命名空间？

<?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 没有提到文档块。

真正重要的是 phpdoc 对待您的评论的方式：

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

namespace MyNamespace;

class MyClass
{
}

被视为您对文件有评论，但没有对确切的 class MyClass 发表评论，因此在生成之后文档将出现错误，提示您没有 class 描述。

第二种情况：

<?php

namespace MyNamespace;

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

class MyClass
{
}

phpdoc 会将 docblock 视为对 class Myclass 的注释，但不会找到对完整文件的注释。所以生成文档后还是会报错

但是，对于这两种方法，我会 select 第二，因为最好有 class 描述，然后是文件描述。

使用 class 描述的 PSR

PSR for using description of class

php

phpdoc

psr-2

psr-1