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一无所知。

真正重要的是phpdoc：

对您的评论的处理方式

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

namespace MyNamespace;

class MyClass
{
}

被视为您对文件有评论，但没有对完全类MyClass发表评论，因此在生成文档后会出现错误你没有课堂描述。

在第二种情况下：

<?php

namespace MyNamespace;

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

class MyClass
{
}

phpdoc会将docblock视为对类 Myclass的评论，但不会发现对完整文件的评论。因此，在生成文档后，您仍会遇到错误。

但是，使用这两种方法我会选择第二种，因为最好有类描述，然后是文件描述。

PSR用于使用类的描述

1 个答案: