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?
Asked
Active
Viewed 384 times
2
Michael Haddad
- 4,085
- 7
- 42
- 82
-
Possible duplicate of [What is the proper PHP function documentation format?](http://stackoverflow.com/questions/1904214/what-is-the-proper-php-function-documentation-format) – Kamil Jarosz Oct 22 '15 at 18:50
-
@kamil09875 It is really not the same question... – Michael Haddad Oct 22 '15 at 18:51
1 Answers
2
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.
miken32
- 42,008
- 16
- 111
- 154
-
That is true, it says that there is an option for a single line and an option for multiple lines, but it does not specify **When** should I use each of them. Thanks. – Michael Haddad Oct 22 '15 at 19:59
-
If you have a single line comment, you **may** use one or the other. End of story. – miken32 Oct 22 '15 at 20:01