В DocBlocks я должен всегда использовать однострочное обозначение при написании одной строки?

Question

Допустим, у меня есть одна строка summaryДолжен ли я исправить это так:

/** summary */

или я могу написать это так:

/**
* summary
*/

Я предпочитаю второй вариант, но нужно ли использовать первый вариант?

1

Решение

Других решений пока нет …

Accepted Answer

В соответствии с документация, «DocComments может быть одна строка по размеру, но также может охватывают несколько строк «(выделено мое.)

Таким образом, вы можете сделать это в любом случае.

1