NuSphere Forums Forum Index
NuSphere Forums
Reply to topic
phpdoc tags


Joined: 23 Jan 2009
Posts: 5
Reply with quote
Hi there

Can I use a specific format in order to make documentation/explations of my code while I'm writing the php code(in the comments) using PhpEd. I wish to be capable to put and see the descriptions of my functions and params details.

is this possible with phped...and how?

I'm talking about a format like (@desc, @param, @return)
sample

Code:

/**
* @desc         function description
* @param      param_type        param_name         description
* @return       int
*/
function      foo( $old_number ){
     $new_number = $old_number * 5;

return $new_number;
}


ps: phpDoc use this format
View user's profileFind all posts by uocSend private message
Guru master

Joined: 05 Jul 2004
Posts: 659
Location: Belgium
Reply with quote
PhpED already uses PHPDoc statements to show additional information with code insight. Try Control+Shift+Space between the brackets or just type one behind a function. Also for code completion (Control+Space) the description will be shown in the status of the popup window.
FYI "@desc" is not required.
View user's profileFind all posts by BlizzSend private messageVisit poster's website


Joined: 23 Jan 2009
Posts: 5
Reply with quote
many thx for the replay with details and shortcuts.

I really can't make it show me the description of a function written by me. where can I find some infos about how to do that?
View user's profileFind all posts by uocSend private message
Guru master

Joined: 05 Jul 2004
Posts: 659
Location: Belgium
Reply with quote
It works without a problem here:

View user's profileFind all posts by BlizzSend private messageVisit poster's website


Joined: 23 Jan 2009
Posts: 5
Reply with quote
get it...it works now...that's cool

one more question pls...what sintax color(setting) use for that appearance?. I didn't find something similar in the setting menu.
View user's profileFind all posts by uocSend private message
Guru master

Joined: 05 Jul 2004
Posts: 659
Location: Belgium
Reply with quote
I don't think you can modify those colors... at least I haven't found out where they hid that yet Smile
View user's profileFind all posts by BlizzSend private messageVisit poster's website


Joined: 23 Jan 2009
Posts: 5
Reply with quote
but your code looks so different than mine, and I have the default settings
View user's profileFind all posts by uocSend private message
Guru master

Joined: 05 Jul 2004
Posts: 659
Location: Belgium
Reply with quote
Ah you meant the actual code, thats easy.
Go to the Tools menu en choose Settings
Then under Editor > Syntax Colors make sure you have the correct language selected and just modify the colors Smile
View user's profileFind all posts by BlizzSend private messageVisit poster's website
phpdoc tags
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
All times are GMT - 5 Hours  
Page 1 of 1  

  
  
 Reply to topic