Re: Doc comment patch
| From: | Andrei Zmievski | Date: | Thu, 13 Mar 2003 21:05:28 +0000 |
| Subject: | Re: Doc comment patch | ||
| References: | 1 2 | Groups: | php.internals |
| Request: | Send a blank email to internals+get-34@lists.php.net to get a copy of this message | ||
On Thu, 13 Mar 2003, Marcus Börger wrote:
> Great!
>
> Some questions:
>
> 1) Will you allow compatibility with doxygen by this:
>
> +<ST_IN_SCRIPTING>"/** "{NEWLINE} {
> + CG(comment_start_line) = CG(zend_lineno);
> + BEGIN(ST_DOC_COMMENT);
> + yymore();
> +}
> +
>
> changed to:
> +<ST_IN_SCRIPTING>("/** "|"/*! "){NEWLINE} {
> + CG(comment_start_line) = CG(zend_lineno);
> + BEGIN(ST_DOC_COMMENT);
> + yymore();
> +}
> +
When Stig and I discussed this feature, I was under the impression that
it would be used in PEAR mostly, and that PEAR would adhere to
JavaDoc-style comments. Is there enough demand for doxygen comments?
> 2) Why is it '/' '*' '*' and SPACE?
That's what Stig told me to use. :) Stig?
> 3) How about single line comments started by '//!'?
I think Doc comments should be multi-line.
> 4) What about removing everything upto '*' if it is the first character
> after a new line starts?
It's a possibility. You basically want to strip the example that I gave
down to this?:
@name foo
@param blah string
-Andrei http://www.gravitonic.com/
* Use the source, Luke. *