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

Скажем, у меня есть одна линия summary, должен ли я право это так:В DocBlocks, должен ли я всегда использовать однострочное обозначение при написании одной строки?

/** summary */

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

/** 
* summary 
*/

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

источник

2015-10-22 Sipo

Возможный дубликат [Что такое правильный формат документации по функциям PHP?] (Http://stackoverflow.com/questions/1904214/what-is-the-proper-php-function-documentation-format) – kamil09875

@ kamil09875 It на самом деле это не тот же вопрос ... – Sipo

Согласно the documentation «DocComments может быть одной линии в размере, но может занимать несколько строк» (курсив мой.)

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

источник

2015-10-22 19:37:44 miken32

Это правда, в нем говорится, что есть опция для одной строки и опция для нескольких строк, но она не указывает ** Когда ** следует использовать каждый из них. Благодарю. – Sipo

Если у вас есть комментарий к одной строке, вы можете ** использовать один или другой. Конец истории. – miken32

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

ответ

Смежные вопросы