NuSphere Forums Forum Index
NuSphere Forums
Reply to topic
auto phpDoc


Joined: 06 Apr 2007
Posts: 48
Location: Gdansk, POLAND
Reply with quote
The really great feature of Zend Studio is phpDoc function -- when you enter /** and hit Enter, the IDE analyzes header of the function below and creates phpDoc block with all the @param and @return syntax, for example:

Code:
function createProduct($pIDProduct, $pIDVariant = 0)
{
  (...)
  return $var;
}


it creates:
Code:

  /**
   * Enter description here...
   *
   * @param unknown_type $pIDProduct
   * @param unknown_type $pIDVariant
   * @return unknown
   */


It really speeds up creating the documentation.
View user's profileFind all posts by NatanielSend private messageVisit poster's website


Joined: 07 Mar 2007
Posts: 44
Location: Lithuania
Reply with quote
I've noticed that in Zend too, very nice feature, this should be implemented in phpEd too Smile.
View user's profileFind all posts by thunder-ltuSend private messageVisit poster's website
Site Admin

Joined: 13 Jul 2003
Posts: 8340
Reply with quote
who cares,
with PhpED you can get even more:
http://forum.nusphere.com/script-to-automate-writing-of-set-get-functions-oop-phpdoc-t3192.html

_________________
The PHP IDE team
View user's profileFind all posts by dmitriSend private messageVisit poster's website


Joined: 06 Apr 2007
Posts: 48
Location: Gdansk, POLAND
Reply with quote
I have tested the script and it's useless for me - it adds some functions (get & set) I don't need at all and I see no reason why it should be added. Also select text & apply is not the way I want to work. Maybe it can be rewritten to match my needs, but this forum is feature request for phpEd, right? In my opinion it should be embedded in the editor, same way as the docBlock is currently created (/** + enter), just extended - with analysis of what's coming next and what are it's params (for functions).
View user's profileFind all posts by NatanielSend private messageVisit poster's website


Joined: 14 Apr 2007
Posts: 96
Reply with quote
I agree that auto-creating at least the shell of the comment block would be a very nice addition.

-r
View user's profileFind all posts by rodericksimpsonSend private message
Site Admin

Joined: 13 Jul 2003
Posts: 8340
Reply with quote
I meant that you can create any text blocks, just need a good script for this.

_________________
The PHP IDE team
View user's profileFind all posts by dmitriSend private messageVisit poster's website


Joined: 11 Sep 2005
Posts: 45
Reply with quote
What is the script for this then? We need auto phpdoc creation not only for classes/functions but for file headers.
View user's profileFind all posts by bendjSend private message
auto phpDoc
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