Уже вторая контора, где требуют всюду писать phpdoc комменты, причем по факту это какая-то бесполезная писанина за авторством К.О.:
/**
* Class FloatToStringConverter
*
* Converts float value to string with specific precision
*/
class FloatToStringConverter
{
/**
* Default precision
*/
private const DEFAULT_PRECISION = 2;
/**
* @var int
*/
private int $precision;
/**
* FloatToStringConverter constructor.
*
* @param int $precision
*/
public function __construct(int $precision = self::DEFAULT_PRECISION)
{
$this->precision = $precision;
}
/**
* @param float $value
* @return string
*/
public function convert(float $value): string
{
return (string)round($value, $this->precision);
}
}
Какая информация потеряется, если убрать phpdoc? Никакой. При этом на написание комментариев нужно время, а еще они создают визуальный шум и затрудняют чтение кода.
Вопрос: зачем использовать комментарии везде, если код самодокументируемый, и они нужны только в исключительных случаях, когда не хватает возможностей языка - типа тайп хинт float|int, коллекции/массивы string[], Type[]?
В 2 раза легче же читается:
class FloatToStringConverter
{
private const DEFAULT_PRECISION = 2;
private int $precision;
public function __construct(int $precision = self::DEFAULT_PRECISION)
{
$this->precision = $precision;
}
public function convert(float $value): string
{
return (string)round($value, $this->precision);
}
}
Средний