pro-dev
@pro-dev

Документирование кода в PHP 7.4 нужно ли?

Всем привет. Делаю Open Sourse библиотеку. И возник такой простой вопрос, но не могу посоветоваться с сообществом. Ранее всегда в свойствах объекта писал док блок с типом поля. Но и так же это делал в методах.

/**
  * This Entity for ....
  */
class Entity
{
    /**
     * @var Id
     */
    public $id;
    /**
     * @var string
     */
    public $status;

    /**
     * @param Id $id
     * @param string $status
     */
    public function __construct(Id $id, string $status)
    {
        $this->id = $id;
        $this->status = $status;
    }
}

С выходом версии php 7.4 появились типизированные свойства и, по сути, док блоки сейчас выглядят как мусор, а так же увеличивают количество строк в файле. Это всё наводит меня на то, чтобы совсем убрать док блоки из кода и использовать его только там, где это нужно. Однако библиотека будет использоваться не только мной, поэтому прошу совета. Подскажите, как лучше оформлять код. Как выше или так? Если не сложно прокомментируйте все за и против. И когда точно нужно использовать док блоки?
class Entity
{
    public Id $id;
    public string $status;

    public function __construct(Id $id, string $status)
    {
        $this->id = $id;
        $this->status = $status;
    }
}
  • Вопрос задан
  • 1145 просмотров
Решения вопроса 2
SilenceOfWinter
@SilenceOfWinter Куратор тега PHP
та еще зажигалка...
свойства то появились, а ide запаздывают + я не уверен что у тебя без них получится сгенерить документацию каким-нибудь phpDocumentor'ом
Ответ написан
@AUser0
Чем больше знаю, тем лучше понимаю, как мало знаю.
А все потребители вашей библиотеки перешли на PHP 7.4? И в средствах разработки у всех потребителей уже всё поддерживается? И ещё, вроде в этих комментариях пишут описание, для чего нужно то или иное значение... Оно само сгенерируется у всех пользователей?
Ответ написан
Пригласить эксперта
Ответы на вопрос 1
syamskoy
@syamskoy
Если вы в методах указываете принимающие и возвращаемые типы, то пхпдок лишний
Если вы перейдя на 7.4 начали указывать типы свойств, то пхпдок не нужен.
Код должен быть легко читаем. В чистом коде не должно быть комментариев - это мусор.
Учитывая ваш пример выше, не пишите phpdoc - без него все понятно и смотрится аккуратно.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Похожие вопросы