NuSphere Forums Forum Index
NuSphere Forums
Reply to topic
How to use phpDocumentor..??


Joined: 07 May 2008
Posts: 7
Reply with quote
Hi,
I'm used to IDE's like eclipse & Visual Studio...
and now for php im trying out phpEd...

I want to know how to document self made functions, variables, classes, member variables, etc?? So if I document them, then the auto complete tool will provide me a quick help...

for e.g

/**
* Cache::exists()
* Checks if the cache already exists
* @return
*/
public function exists()
{
return file_exists($this->getFullFileName());
}


the comment above the function name... how do i generate it within phpEd itself.. ??
the phpDesigner IDE supports this by right clicking and selecting "Add documentation to function"


please help.. as i really need this feature to work on my projects.

thanks
View user's profileFind all posts by percypaisSend private message


Joined: 10 Feb 2004
Posts: 93
Reply with quote
From your example code, it doesnt appear that you are using the phpdoc syntax correctly, which is why PhpEd isnt picking up your functions to include in the auto complete functionality.

http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_phpDocumentor.howto.pkg.html#basics.docblock

So for you example you should probably have something like

/**
* Checks if the cache already exists
*
* A longer description of the above if needed.
*
* @access public
* @return boolean
*/
View user's profileFind all posts by gilzowSend private messageAIM Address


Joined: 18 Sep 2007
Posts: 54
Location: Croatia
Reply with quote
Frankly neither is PHPEd for that matter.
The problem still persists 'cos correct syntax would be:
Code:

/**
 * My description
 */

not
Code:

/**
* @desc My description in PHPEd
*/

Not to mention HTML blocks that are not parsed in PHPEd like <p><li><code> etc.

When one is using 3rd party class/frameworks this can get really ugly.
View user's profileFind all posts by konixnetSend private messageVisit poster's website
Site Admin

Joined: 13 Jul 2003
Posts: 8334
Reply with quote
Quote:
When one is using 3rd party class/frameworks this can get really ugly

would you please suggest an example of such 3rd party class/framework?

_________________
The PHP IDE team
View user's profileFind all posts by dmitriSend private messageVisit poster's website
How to use phpDocumentor..??
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