Is it really necessary do something like this: /** * ... * * @return void */ I have quite a few methods that don't have a return value, and it seems really redundant to put something like this in the comment. Would it be considered bad form to leave it out? ...
How to automatically format PhpDoc comments in Netbeans? I'd like to have comments aligned like this: * @author Author Name <[email protected]> * @package Doctrine * @subpackage Table * @license http://www.opensource.org/licenses/lgpl-license.php LGPL * @version $Revision: 67999 $ * @link www.phpdoctrin...
In a PHP project, even when front controller logic is used for the main application, there can be many stand-alone scripts, ajax snippets and so on. Is there a standardized way - either PHPDoc or something else - to define in the first comment block of the script what GET and/or POST parameters the script will accept / require and of wh...
i have phpdoc through mamp. and i followed their tutorial, typed this in the Terminal. pear config-set data_dir /path/to/document_root/pear of course i changed the /path/to/document_root to my web space folder. but then what? how can i access phpdoc through webinterface? ...
does netbeans include phpdocumentator so you can comment your code? is there some guide on how to use it, eg. how should i comment, how to read them and how to print them out? ...
Some of the new PHP 5.3 features, including namespaces and anonymous functions, are not compatible with PHPDocumentor, even with the latest release. For example, it just raises an error when it encounters "a function with no name", i.e. a closure. So, are there any other open-source tools that generate API documentation (preferably in HT...
We are currently in the beginning of a new project, and would like to (for once) comment as much as possible from the start to help future development. I have tried to find out what best practices are of using phpDoc in Eclipse, but with pretty slim results. Can you share your best practices and tricks of using phpDoc to comment stuff ...
I found this in Zend Framework : /**#@+ * @access protected */ /** * @var Zend_Mail_Transport_Abstract * @static */ protected static $_defaultTransport = null; ... /**#@-*/ Are these "open" and "close" tags ? Are they supported by phpdoc ? I can't find any documentation about it (and it's not possible to google it) Thank you...
I'm working on Magento templates, but this issue would apply to any template loading system. As these templates are loaded by the template engine there's no way for the IDE (in this case Aptana) to know what object type $this is. Potentially it could more than one object as a single template could be loaded by multiple objects, but i...
All the files in the code base I am documenting will always use the same version "string" Is there a way I can specific in a single place for the PhpDocumentor to use the same version for all files, regardless if it is specified or not (should auto-inherit) ...and what other tags would this be useful for off the top of your head? Edit:...
hi, can any body help me on separating this example of data that i need to parse and seperate text just like PHPDoc. It is PHP source code. The example string : function one_to_tree() { //bla bla bla return FALSE; } function two_to_tree() { //bla bla bla return FALSE; } function three_to_tree() { ...
Do you know any tools that can run through the code and find defects in javaDoc blocks? (would be nice to parse other languages also, like PHP, C#, etc). ...
a while ago i could comment any code in php with netbeans like this: /* * * */ I just typed /* ENTER and netbeans gave me that lines above. then when i typed @ it gave me a full list of all available tags (author, param and so on). i reinstalled my mac and since then it hasnt worked. someone knows why and how i can activate it? i...
so in a folder PayPal i've got multiple classes for using their API. i want to make a documentation for how to use all the classes in a sequential way. so here is my questions: how do i create a package for them? cause above each class i used phpdoc tag @package PayPal. is a package in php just a folder? where do i put documentation f...
I use my OSX for dev. PHP and now i need to try PHPDoc but how? sombardy know a software? or how i can doe it? i try to look here http://manual.phpdoc.org/HTMLSmartyConverter/HandS/ric_INSTALL.html but i hobe i can found a GUI software the out. :) tanks for all help. ...
What is the best way to document changes in a function with PHPDoc? Something like @change 2010.20.16 user added feature x @change 2010.20.26 user added feature y would be great. But assume there's no @change option... If i add it anyways, what will PHPDoc do with it? Or is there a better / more correct way to document function ch...
I have multiple inheritance like this one: http://stackoverflow.com/questions/356128/can-i-extend-a-class-using-more-than-1-class-in-php (let's not discuss this approach itself please) and want my IDE to know about inherited class methods and properties. Is there a way to do it with PhpDoc? ...
Hey Guys, i hope someone can help me out on this one here. I use several associative arrays in my php application and i'm using php documentor to comment my sources. I never really did specified comments for the arrays in an array, but now i need to do that and dont know how. $array = array('id' => 'test', 'class' => 'tester', 'options'...
Okay, I'm fed up with phpDocumentator. It consumes way much more memory (1.4 GB) and time (5 minutes on 2.6GHz Core 2 Duo) than I'm willing to give it. Does there exist some really compatible program to generate documentation for PHP code? I've tried PHPDoctor, which looks nice, but it has some missing features. However it is probably c...
Please consider the following code with which I'm trying to parse only the first phpDoc style comment (noy using any other libraries) in a file (file contents put in $data variable for testing purposes): $data = " /** * @file A lot of info about this file * Could even continue on the next line * @author [email protected] *...