Использовать стандарт PHP DocBlock/PHPDoc внутри реализаций, это плохо?

Хорошая или плохая практика - помещать стандартный док-блок внутри кода метода в дополнение к месту по умолчанию?

      /**
 * This is calss desc.
 * 
 * @author My self
 */
class MyClass
{
  /**
   * This is method description.
   * 
   * @param mixed $arg this in the one
   * 
   * @return array
   */
  public function myMethod($arg)
  {
    .
    . Some code
    .
    /**
     * This describe the portion of code with standard docblock
     * @author Some one
     */
    ... The code ...


    return ['...'];
  }
}

Или в этих случаях вместо

      /**
 * This describe the portion of code with standard docblock
 * @author Some one
 */

ты должен поставить

      /*
 This describe the portion of code with standard docblock
 @author Some one
 */

Или есть обязательная рекомендация избегать каких-либо комментариев внутри реализации метода?

0 ответов

Другие вопросы по тегам