phpdocblocks

In DocBlocks, should I always use a single line notation when writing one line?

Let's say I have one line of summary, must I right it like that:

/** summary */

or can I write it like this:

/**
 * summary
 */

I prefer the second option, but is that required to use the first option?

Solution

  • According to the documentation, "DocComments may be a single line in size but may also span multiple lines" (emphasis mine.)

    So, you can do it either way.