| View previous topic :: View next topic |
| Author |
Message |
Blizzy
Joined: 29 Jun 2009
Posts: 3
|
 Posted: Mon Jun 29, 2009 9:24 am Post subject: Bug: phpDoc and @param |
 |
|
The syntax of @param tag is:
| Code: | | type [$varname] description |
This means that the $varname is only optional, but NetBeans acts like it's obligatory.
e.g. when I write:
| Code: | /**
* @param array|mixed one or more arguments
*/ |
NetBeans think that the variable name is the word 'one'.
It should be fixed. I (and many others who e.g. write PHP libraries) never write variable name into @param, so it's quite annoying when NetBeans can't process the documentation well.
There are many reasons, for example if I change the variable name (using the ctrl+r to change all occurances), I have to change it in documentation too... so I rather don't write the variable name at all. |
|
| Back to top |
|
 |
Filip Zamboj
Posted via mailing list.
|
| Posted: Mon Jun 29, 2009 10:53 am Post subject: phpDoc and @param |
|
|
Hi.
submit a bug, please. http://www.netbeans.org/community/issues.html
Thanks a lot.
-------------
Filip Zamboj
Sun Microsystems
http://www.netbeans.org/community/issues.html
http://qa.netbeans.org
Blizzy wrote:
| Quote: | The syntax of @param tag is:
Code:
type [$varname] description
This means that the $varname is only optional, but NetBeans acts like it's obligatory.
e.g. when I write:
Code:
/**
* @param array|mixed one or more arguments
*/
NetBeans think that the variable name is the word 'one'.
It should be fixed. I (and many others who e.g. write PHP libraries) never write variable name into @param, so it's quite annoying when NetBeans can't process the documentation well.
There are many reasons, for example if I change the variable name (using the ctrl+r to change all occurances), I have to change it in documentation too... so I rather don't write the variable name at all.
|
|
|
| Back to top |
|
|
Blizzy
Joined: 29 Jun 2009
Posts: 3
|
|
| Back to top |
|
|
|
|
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You can attach files in this forum
You can download files in this forum
|
|
|
|
FAQ
Search
Memberlist
Register
Profile
Log in to check your private messages
Log in
