PHPDocFill: write beautiful PHP documentation easily

By -
Have you ever needed to write PHP code so fast that you didn't have time to properly comment it? These situations tend to happen a lot when you are being pressured by your boss (I know what I'm talking about) to deliver projects under strict deadlines. Once the project is delivered, it is always a pain if you ever have to come back to the code and comment it. 

 To make it easier and more enjoyable to comment your PHP code (afterwards I suppose), I've developed a simple tool called PHPDocFill that does the following:
- scans the current folder and subfolder to find all php files in your project
- analyzes your PHP files to find PHPDoc documentable elements
- easily insert or edit documentation blocks
- it even generates a simple HTML manual based on the documentation found in all the files

 Full documentation, information, downloads and screenshots are available on its official site.
Official site: http://cnedelcu.net/phpdocfill/

Comments

Paki said…
Excellent! :D
I don't use PHP often but the next time I'll try your tool ;)
Thu Jun 13, 06:33:00 PM
Unknown said…
hi Clément!

Thank you for this good work.
However, I've spotted some bugs in your code :
- line 446 : you must declare the "UpdateDocBlock" function as static (for the line 638 to work)
- line 1071 : you should check that "Action" is a valid index for the "$_POST" array
- line 250 & 256 : the constant "T_SPECIAL_BRACKET" is undefined (at least, on my filthy IIS Server w/ PHP)
- line 274 & 275 : you should check that the index "$i+1" and "$i-1" exists in the "$tokens" array, moreover for the first and the last iteration. Other said, you should check that "$i" is ">0" for the "$i-1" part, and that "$i" is "<(count($tokens)-1)" for the "$i+1" part
- line 309 (it's a consequence of the above) : you should check that "$previousToken" exists (in the case of the first iteration, it's not true)
- line 364 : you should move the declaration of "$complete = 0" et "$total = 0" out of the two "if's" (so right under "$completion =-1" in order to be used in the return block at then end of the function
- line 381 : you should use two " " right after the "< /span>" (end of the "bullet") to be sure that the space is sufficient beetween the comment completion percentage and the name of the file (which is not the case, at least under Chrome)

I think that it's all. I'm sorry if some of the errors I pointed out are only due to a bad configuration of my Web Server.

Regards!
Tue Jun 18, 03:57:00 PM
Clément Nedelcu said…
Hi Clément,
Thank you for the feedback.
Indeed I have not suppressed the NOTICE messages, so I will need to release a new beta soon.
Tue Jun 18, 04:17:00 PM
Unknown said…
OK, good to know!
Tue Jun 18, 04:19:00 PM
Unknown said…
Great Post, Actually PHP is a beautiful source for developing a database driven web application, I love this post, thanks for spending your time for discussing about this topic.
Regards,
PHP Course Chennai
Tue Jul 21, 08:35:00 PM
fnaf 3 said…
Thanks for all your information, Website is very nice and informative content.
----
five nights at freddy's download | fnaf | five nights at freddy's
Wed Jul 29, 03:26:00 PM
Post a Comment

Popular posts from this blog

Nginx error 413: Request entity too large Quick Fix

By -
A quick article today about a common error people encounter with Nginx: the infamous 413 Request Entity Too Large HTTP error. I had the problem myself just yesterday on one of my newly configured servers, so I thought I'd make a blog post about it to make sure I don't forget this next time. Error 413: what does it mean? This error shows up when a visitor sends too much data in the HTTP request. This is normally caused by: • an overy large file being uploaded by the visitor • more generally too much POST data being sent by the client The fix is as simple as setting a directive in your Nginx configuration, read on below. How to fix it? client_max_body_size To fix this, you need to increase the value of the client_max_body_size directive. This directive defines the maximum amount of data Nginx will accept in an HTTP request. By default this value is set to 1 megabyte, meaning if you attempt to upload a file larger than 1 megabyte you'll be getting an  Error ...
Read more

Dealing with Nginx 400 Bad Request HTTP errors

By -
Today I'll write about something I experienced personally, on my websites. Some visitors reported that they were getting a "400 Bad Request" Nginx error randomly when visiting pages. And when they start getting that error, they can't access the site anymore: it'll output the same error no matter the page, until you "clear your cache and cookies". The error is easily understandable and is likely to be caused by... too much cookie data. Every time a visitor loads *any* page/content/file of your website, it sends the cookie data to the server. Cookie data is sent under the form of 1 header line starting with "Cookie: ". Basically, Nginx by default is configured to accept header lines of a maximum size of 4 kilobytes. When a line in the headers exceeds 4 kilobytes, Nginx returns the '400 Bad Request' error. Cookie data sometimes gets big, so it causes the error. It particularly happens on forums like vBulletin, Invision and others...
Read more

Affiliate module for Interspire Shopping Cart

By -
Image
Hello, I have already implemented this module on two shops rather successfully. The concept is quite simple: websites that want to get rewarded through affiliation must link to your website using an identifier in the URL. If your website is http://website.com/, then your links must be of the form http://website.com/?ref=123 where 123 is the affiliate ID. when a visitor clicks the link, the affiliate ID will be placed in a cookie that will expire after 15 days (this can be configured) when the visitor purchases an item: if the affiliate ID cookie is still enabled, the affiliate will be credited of a certain amount, it can be a share of the sale or a fixed amount. affiliate accounts are simple customer accounts, there is no modification to make regarding accounts. When a sale is made, they receive store credit. They can either spend the store credit to purchase items on the store, or they can manually request for a withdrawal (managing withdrawals is up to you). I will detail the i...
Read more