News Feed
Jobs Feed
Sections




News Archive
feed this:

PHPMaster.com:
Introduction to PhpDoc
January 10, 2012 @ 10:07:26

On PHPMaster.com today there's a new post from Moshe Teutsch about working with docblock comments in PHP scripts and how to use the phpDocumentor tool to generate the documentation from them.

If you've ever tried to read code written by someone other than yourself (who hasn't?), you know it can be a daunting task. [...] PhpDoc, short for PhpDocumentor, is a powerful tool that allows you to easily document your code via specially formatted comments. [...] By using PhpDoc, you can make it easy for others (and yourself) to understand your code - weeks, months, and even years after you've written it.

He introduces the concept of "docblocks" and includes several examples of how to comment things like packages, files, classes and functions/methods. Finally, he wraps up the post with an example of using the "phpdoc" command to run phpDocumentor and build the docs. In the comments, another tool is also suggested - DocBlox, a project that still parses the same docbloc syntax but does it in a much more memory efficient way (and is an actively maintained project).

0 comments voice your opinion now!
docbloc introduction phpdocumentor docblox comment phpdoc


Liip Blog:
PHPDoc Compilers and the @inheritdoc
July 26, 2011 @ 09:29:06

On the Liip blog there's a new post that compares some of the popular PHPDocumentor-formatted comments parsers. They're looking specifically at the support for interfaces, not just the usual classes and methods.

The interfaces define the standard and are extensively documented. The implementation was built by copying the interfaces and implementing the methods. Now we have the documentation comments duplicated, which is a pain to maintain if we clarify or change anything in the interfaces documentation. [...] In PHP, there is a couple of doc compilers. While they basically all follow the same syntax as Java uses, none of them gets everything right unfortunately.

The four covered are PhpDoctor, DocBlox, PHPDoc and Doxygen. They look at things like namespace support, the inheritance information they generate and if it correctly uses the "@inheritDoc" tagging functionality.

0 comments voice your opinion now!
inheritdoc phpdocumentor standard library phpdoctor docblox phpdoc doxygen


Frederic Marand's Blog:
New SVN repository for PHP-GTK
April 16, 2009 @ 11:18:46

Frederic Marand has pointed out a new subversion repository that's been set up for the documentation on the PHP-GTK project.

After recent complaints in the PHP-GTK mailing list, auroraeosrose mentioned mgdm has set up a SVN repository for the docs, to ease working on them. This new repository is available at http://svn.thefrozenfire.com/phpgtkdoc/

The trunk currently has repositories for the gtkdocs and the phpdoc application you can check out and use to generate and develop on the documentation locally.

0 comments voice your opinion now!
subversion svn repository phpgtk documentation gtkdocs phpdoc


Netbeans Blog:
Code Completion for the Kohana & Code-igniter Frameworks
January 29, 2009 @ 08:49:22

On the Netbeans blog today, there's a new post that points to two articles about the IDE - one showing code completion in the Kohana framework and the other on completion in CodeIgniter.

How to achieve PHP code completion in Netbeans for the CodeIgniter, Kohana frameworks? See following articles:

Both articles come from the "My Beloved PHP" site:

0 comments voice your opinion now!
completion kohana codeigniter framework phpdoc


Sara Golemon's Blog:
create_function() is not your friend
May 21, 2007 @ 09:31:00

In response to this previous post from Felix Geisendorfer, Sara Golemon shares a few thoughts on why she thinks it's just the other way around - create_function is not your friend.

In the short post she lists just a few of the issues surrounding the use of the function including that it:

  • is prone to critical abuse by user-supplied code
  • skips opcode cache optimizations
  • encourages not using comments (evil)
  • 100% blind to reflection or PHPDoc style documentation generation

0 comments voice your opinion now!
createfunction eval abuse opcodecache reflection phpdoc createfunction eval abuse opcodecache reflection phpdoc


Greg Beaver's Blog:
phpDocumentor and PEAR - interesting crossing of paths
May 02, 2006 @ 22:06:50

Greg Beaver has a new post today on his blog concerning the interesting crossing paths of the phpDocumentor project and PEAR.

Yesterday and today I released phpDocumentor 1.3.0RC6. Aside from a number of exciting features and many important bug fixes, including some bugs opened over 2 years ago (!) this release is unique in another way: in addition to working as a PEAR-installable package, it also works as an extracted file.

He notes that this improvement not only makes installing the phpDocumentor package more flexible, but it also makes it a snap to get up and running. Those used to the PEAR package system will be happy to know it's a simple "pear " command away. It makes full use of the package.xml 2.0 features to really make the install nice and clean.

0 comments voice your opinion now!
pear phpdocumentor cross paths install phpdoc package pear phpdocumentor cross paths install phpdoc package



Community Events











Don't see your event here?
Let us know!


conference functional opinion release interview language composer code podcast zendframework2 framework series introduction example api community testing development unittest tool

All content copyright, 2013 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework