#Article

Кстати, а вставки кода в комментариях — тоже кучерявая тема в #PHP.

👉 Есть Java-like вариант: оборачивать тегами <code>. Скуфы, мб, помнят.
Но мы, вроде, уже ушли от HTML среди PHP 😏

class CustomerDTO
{
    /**
     * @var non-empty-string Comment here
     * 
     * <code>
     * $x = foo()->bar();
     * </code>
     */
    public readonly string $name;
}

👉 Есть Python-like вариант: делать отступы

class CustomerDTO
{
    /**
     * @var non-empty-string Comment here
     * 
     *     $x = foo()->bar();
     */
    public readonly string $name;
}

Тут не очень очевидно, сколько пробелов от звёздочки должно быть: по логике 1+4, но не сходится с разметкой Tab-ов.
Это активно используется в Symfony и PhpStorm это даже рендерит. Кстати, кто знает, как отключить этот рендеринг для классов из vendor?

👉 Есть Markdown-like вариант:

class CustomerDTO
{
    /**
     * @var non-empty-string Comment here
     * 
     * ```php
     * $x = foo()->bar();
     * ```
     */
     public readonly string $name;
}

Мне нравится markdown, но это не рендерится PhpStorm'ом. Однако, рендерится документором.
Python-like на документоре не проверял, может тоже рендерит.