Всем привет. Делаю 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;
}
}
Средний
