News Feed
Jobs Feed
Sections



Recent Jobs

News Archive
feed this:

Ben Selby's Blog:
DocBlox Plugin For Sublime Text 2
February 06, 2012 @ 15:39:34

Ben Selby has released a Sublime Text 2 plugin for the popular PHP-based documentation generation project DocBlox.

It seems that the editor of the moment is Sublime Text 2 and sadly I have to tip my hat to Gary Rockett for showing it off to me one day.. Since that day, I've been a 100% convert. [...] So, I decided to peak into the PHPUnit [plugin from Stuart Herbert] to see if I could create a DocBlox Plugin. It turns out you have to write Plugins in Python, which is interesting, since I know very little python. There seemed to be enough code there to get me going, so I now have a working DocBlox Plugin.

The result is a plugin that, once installed gives you a new context menu option to "Generate documentation" for the selected file. The console shows the progress of the build. You can get the plugin from Package Control or by grabbing it from github directly.

0 comments voice your opinion now!
docblox documentation plugin sublimetext2 generate



Tales of a Coder:
DocBlox - Pain Free Documentation
December 01, 2011 @ 09:56:27

On the Tales of a Coder blog there's a recent post about DocBlox, an alternative to the usual phpDocumentor for generating automatic documentation, and how it made it "pain free" for her current project.

Want to generate documentation for your PHP project, but keep putting it off? Can't be bothered wading thigh deep in documentation, screaming WHY WON'T IT WORK as you try to set it up? Look no further. DocBlox is pain free and you'll be up and running, literally in a few minutes.

She includes a guide to getting the latest DocBlox installed and configured to work with your project. The configuration is a straight-forward XML file, so changing the settings to match your needs is easy (more on the config here). Once this is configured, building your documentation is one command away. For more details on DocBlox, check out the project's website.

0 comments voice your opinion now!
docblox phpdocumentor painfree documentation docblock tutorial


Reddit.com:
Which MVC framework has the best documentation and user community?
October 14, 2011 @ 10:17:22

On Reddit.com there's a new post that asks the question, "which framework has the best documentation and community?"

About to dive into MVC and wondering which one has the most wealth in terms of documentation/code comments as well as a decent community.

Suggestions in the comments include both old and new options including:

1 comment voice your opinion now!
mvc framework documentation user community opinion


PHPMaster.com:
Documentation Makes the World Go Round
October 04, 2011 @ 09:03:16

On PHPMaster.com today there's a new article emphasizing something that lots of developers forget to make a part of their process when writing code - creating useful documentation to help make your code that much clearer.

If you're writing code that will be shared with others, put yourself in their shoes. Don't let your project lose potential users, community members, and possible contributors all because of insufficient documentation.

He (Matthew Turland) suggests a few things to keep in mind as you're writing up your documentation - the content is "king" (an emphasis on good descriptions/examples/use cases), open it up to external contributions using things like wikis (or even stored in the source code repository) and a focus on technical writing skills. Even the best tools out there can suffer if there's poor or no documentation.

0 comments voice your opinion now!
documentation application code opinion content usecase example technical writing


DZone.com:
There's no reason not to switch to DocBlox
September 01, 2011 @ 13:35:03

On DZone.com there's a recent post from Giorgio Sironi sharing his opinion on what should be your choice of automatic documentation generation tools in your PHP app, that there's no reason not to switch to DocBlox.

Alessandro Nadalin signals these three options for Api documentation generation, the process of extracting Api informations on classes and methods from a folder full of source code: phpDocumentor, doxygen and DocBlox. A PHP tool, faster than doxygen in implementing new features, and actively developed: these are the factors that made me choose DocBlox as my new default Api documentation mean.

He covers the installation of the tool (from its PEAR channel), some of the features it comes with, a link to their demo and some of his impressions after trying it out on his codebase.

0 comments voice your opinion now!
docblox docblock documentation opinion tool


Michelangelo van Dam's Blog:
Quality Assurance on PHP projects - PHPDocumentor
July 27, 2011 @ 08:51:48

Michelangelo van Dam has posted the latest in his "quality assurance in PHP projects" series today with a look at something that can make your life and documentation easier - PHPDocumentor.

Unfortunately I've come across too many lines of code that were just lines of code, no comments or annotations provided. So, in best cases I could guess the types and parameters, but in many it was too obfuscated. I already talked about usage of a code sniffer like PHP_CodeSniffer in my previous post where you can validate the usage of comments in the code. But forcing developers (using a pre-commit checker) into writing documentation with their code is not really a good thing.

He suggests using something like PHPDocumetor (there's other PHPDoc parsers including DocBlox and Doxygen out there) to automatically generate documentation for your code based on its comments, giving your developers easier web-based access to the contents. He includes some sample docblocks for a class/method and gives an example command line call to build docs based on a project. A screencast and screenshot of the generated site shows the results of the run.

0 comments voice your opinion now!
phpdocumentor docblock parse quality assurance documentation


Philip Olson's Blog:
One way PHP may capitalize on its popularity
July 22, 2011 @ 08:05:46

Philip Olson has a (tongue-in-cheek) post to his blog today about how PHP can make the most of its popularity financially.

Today Rasmus mentioned that he received a $500 offer for the php.net domain name. Discussion ensued, which ultimately led to the indisputable belief that php.net is worth over 10 million US dollars. Therefore, let's think about this further...

He compares the worth of several popular languages (with a "reliable source") and does some math where PHP.net account holders would profit from the popularity over other languages. On a bit more serious note, though, he points out a few ways that you can contribute or get involved in the PHP project on several fronts:

0 comments voice your opinion now!
popularity capitalize opinion contribute project mailinglist documentation


PHP.net:
PHP Documentation Update
June 27, 2011 @ 08:57:33

The PHP documentation team has made a new announcement about some major changes that are happening with the PHP documentation - three interesting new additions to this part of the PHP project.

PHP has several [three] new documentation features that the community should be aware of.

They've introduced the following:

  • PHP manual pages (man pages) - pman - installed via PEAR
  • An enhanced CHM (Windows help) version of the manual with user notes
  • The Online Documentation Editor allowing edits from anyone.
0 comments voice your opinion now!
documentation project pman manual page chm windows online editor


DZone.com:
What I Love/Hate About PHP
April 20, 2011 @ 09:05:20

On DZone.com today there's a new post from Eric Hogue talking about the love-hate relationship he has with PHP (as a developer of five years with it).

I have been programming in PHP for 5 years now. I did not choose this language, I had to learn it to work on the code of the company my bosses bought. Since I started, I heard many rants about how bad PHP is. Some where valid, but a lot of them are just blaming the language for bad code written by bad programmers. I am by no mean an expert in programming languages or PHP, but here is my take on the language I use every day.

His "good" section mentions one of the most popular things about the language - its quality of documentation. He also talks about the interactive shell and the community that surrounds the language. In the "bad" category, though, he points out things like the low barrier for entry ("a blessing and a curse"), the changing order of parameters in function calls and that a constructor of a child class doesn't automatically call the parent's constructor.

0 comments voice your opinion now!
love hate opinion language documentation easy community


Victor Farazdagi's Blog:
New Project Phrozn - static site generator in PHP
April 15, 2011 @ 11:02:03

On his blog today Victor Farazdagi introduces a new tool he's developed to help make the creation of static sites even easier - Phrozn, a static site generator that takes content and wraps it in a site's template and structure and outputs it for easy integration.

Given the scale of how client-side technologies (such as JavaScript) evolved, most of dynamic functionality can be implemented using client-side scripts + remote web-services (e.g. Disqus for comments). More than often we a going down that road even on our completely dynamic sites - it makes things more simple.

He gives the example of being able to write the content in VIM and run a single application - Phrozn - and generate the new page to add to the site. He sees it as a good alternative to something like WordPress where most people only use 1% of the functionality it offers. You can find out more about the project by looking into its documentation or you can just dive into the code by grabbing it from github. As a side note, several other tools, like Jekyll are "blog aware" and can be used similarly.

0 comments voice your opinion now!
static site generator phrozn blog project github documentation



Community Events





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


api framework conference opinion introduction application language custom test interview development symfony2 release unittest series community component security podcast phpunit

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