DooPHP Documentation2009-07-22 17:26:49
DooPHP Documentation
I have been receiving comments that DooPHP is not well documented as it advertised.
I want to make a correction here, the Documentation you guys are asking for is instead a Tutorial which is being written at the momnet. I know people like simple walkthrough like CodeIgniter user guide. HOWEVER, DooPHP is well documented, almost EVERY line in the source in Javadoc style! And please note that I have uploaded the Class reference documentation which is a common thing in framework or programming language such as Java and ActionScript. Like this Adobe document: http://livedocs.adobe.com/flash/9.0/ActionScriptLangRefV3/flash/display/BitmapData.html
With the complete Javadoc style comments in the framework source, you are able to use code hinting in your favorite IDE. With the API document, you can see every single function, their visibility, parameters, return types, descriptions, examples, etc... It is well documented and please do not criticize me on this. CI doesn't even have one.
What DooPHP needs now is a simple tutorial/user guide. For those who can't wait, simply view the demo which serves as simple tutorial.
Thank you, and please don't flame me on this :)
Published under: News & Updates
2 Comments:
Sergio Oliveira said: I agree
Wed, 22 Jul 2009 09:42pm
I think you're absolutely right. I took the time to explore the source code and the API documentation and it's very clear, simple and straightforward, and the code hinting on netbeans (my editor of choice) just make's it even better. the CI user guide is very good, and it helps a lot, especially for newbies, but on the long run, building large apps, CI code and documentation sucks. So keep up the good work. :) i really enjoy this framework.. Best of luck! 
Leng said: thank you
Wed, 22 Jul 2009 09:45pm
Thanks for your support! I am a great Netbeans fan too. If you have any ideas on writing tutorials do post it in the forum. Doophp currently lack of simple tutorials 
About
Categories
Archives
- February 2011 (3)
- December 2009 (1)
- October 2009 (3)
- September 2009 (4)
- August 2009 (5)
- July 2009 (13)
