Skip to main content

Home/ PHP Programming/ Group items tagged documentation

Rss Feed Group items tagged

jdr santos

PHPXref - The PHP Cross Referencing Documentation Utility - 0 views

  •  
    PHP Cross Referencing Documentation Generator
anonymous

DocBlox - 7 views

  •  
    PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration
  •  
    PHP 5.3 compatible API Documentation generator aimed at projects of all sizes and Continuous Integration
Sarah HL

Dr. Dobb's | Extreme Testing | juin 1, 2003 - 0 views

shared by Sarah HL on 29 Jun 09 - Cached
  • First, you quickly add a test
  • TDD employs five basic steps
  • The second step involves running your tests
  • ...15 more annotations...
  • Third, you make a little change to your functional code
  • Next, you run the tests
  • In the optional fifth step, you refactor your code to remove any duplication.
  • two simple rules. First, you should write new business code only when an automated test has failed. Second, you should eliminate any duplication that you find.
  • Your designs must consist of highly cohesive
  • You write your own tests because you can’t wait
  • the running code providing feedback between decisions
  • Test-Driven Development (Addison-Wesley 2003)
  • a Smalltalk system with a completely test-driven approach that took four years and 40 person-years of effort
  • there’s far more to testing than unit tests, so you’ll still need other testing techniques such as functional testing, user acceptance testing, system integration testing and so on.
  • you have a clear measure of success
  • most programmers don’t read the written documentation for a system; instead, they prefer to dig right into the code.
    • Sarah HL
       
      Follow the "natural" tendance of the developers, a pro TDD
  • Your acceptance tests define exactly what your stakeholders expect of your system; therefore, they truly do determine a good portion of your requirements.
  • Bob Martin says it best: “The act of writing a unit test is more an act of design than of verification. It’s also more an act of documentation than of verification.
  • Side by Side: Comparing TDD and AMDD TDD shortens the programming feedback loop; AMDD abridges the modeling feedback loop. TDD provides detailed specification (tests), while AMDD provides traditional specifications (agile documents). TDD promotes the development of high-quality code; AMDD encourages high-quality communication between your stakeholders and other developers. TDD provides concrete evidence that your software works, whereas AMDD supports your entire team, including stakeholders, in working toward a common understanding. TDD provides finely grained, concrete feedback in minutes. However, concrete feedback requires developers to follow the practice Prove It With Code, and they may become dependent on non-AM techniques; AMDD lets you get verbal feedback in minutes. TDD ensures that your design is clean by focusing on creation of callable and testable operations; AMDD lets you think through larger design and architectural issues before you code. TDD isn’t visually oriented; AMDD is. Both techniques are new and therefore may be threatening to traditional developers. Both techniques support evolutionary development. —S. W. Ambler
jdr santos

Spoon Library - 0 views

  •  
    Spoon is a PHP5 library that stands for speed, both in page execution and coding agility. Because of it's clear and logical structure, it offers a very small learning curve for both the experienced and not-so-experienced developer. Spoon provides a well documented library with a large collection of classes that you can use while building the next Web 2.0 application.
Sarah HL

PHP Depends On You | BrandonSavage.net - 0 views

  • elf in the community
  • PHP is one of the world’s largest open source projects.
  • people who write open source software generally aren’t paid to do it.
  • ...6 more annotations...
  • the core of PHP is contributed by people who are solely interested in making PHP better for their professional endeavors
  • it can be as simple as contributing to the documentation, or submitting a bug report
  • The community exists because people choose to contribute.
  • file a bug report or write some documentation today.
  • Remember: PHP depends on people just like you.
  • My Boss told me to prepare a paper how we interact good with open source project and how we can generate a win win situation on both sides by submitting (correct) bugreports.
Sarah HL

PHP Worst Practices at blog.phpdeveloper.org - 0 views

  • Beware the Outsiders
  • Sure, you could cobble together your own library to add that feature and yes, it might integrate excellently with your code, but what does that gain you? One of the points of Open Source development is to share your knowledge with the rest of the community.
  • Unplanification
  • ...8 more annotations...
  • This would be the combined voices of everyone in your past that tried to teach you the mantra: “Plan First, Code Later”.
  • The Documentation Wasteland
  • If you’re writing your code without any sort of documentation, you’re dooming you and possibly future maintainers of the code into many a pointless search to try to figure out why method a() returns two completely different value types depending on which parameters it’s given.
  • ets you know the “why” instead of just the “how” the code gives you
  • You’d be surprised how often you’ll find yourself referring to it once it’s reliable.
  • Free Your Mind
  • You, as a developer, know that there’s always more than one way to solve a problem.
  • Just like ‘anti patterns’, who are an important read as well, ‘worst practices’ help developers avoid mistakes.
Sarah HL

Rasmus Lerdorf: PHP Frameworks? Think Again. - 0 views

  • Rasmus Lerdorf is the creator of PHP and still continues as a core developer to the PHP project.
  • heavy Twitter mashup that he created. This does a lot of database calls and a lot of behind the scenes work. By hand-tuning it he was able to get on the order of 280 req/sec.
  • "Any script based language is simply not fast enough".
  • ...2 more annotations...
  • So, are there any frameworks that don’t suck? Rasmus did mention that he liked CodeIgniter because it is faster, lighter and the least like a framework.
  • It all starts with “I don’t need a framework.” 2. Then you create 7 classes. 3. Now you have a small library of classes. 4. Then you create an application that uses your library. 5. It works and it’s fast, hurray! 6. Then someone asks you to extend the functionality of your application. 7. And they keep asking for more, and more, and more and more… 8. Now you have 43 classes. 9. You’ve learn so much in the last 2 years. Design patterns, security, performance, testing… 10. What once was a small library is now a big, ugly, un-tested, un-documented, scary framework. 11. Then you change jobs. 12. And you create another 7 classes… This has been happening for the last 30 years.
Sarah HL

ongoing · Test-Driven Heresy - 0 views

  • As a profession, we do a lot more software maintenance than we do greenfield development.
  • the deep-TDD rules: ¶ Never write code until you have a failing test. Never write any more code than is necessary to un-fail the test.
  • we do way more maintenance than initial development. And in my experience, the first-cut release of any nontrivial software is pretty well crap.
  • ...38 more annotations...
  • But to do that well, you absolutely must have enough test coverage that you just aren’t afraid to rip your code’s guts out
  • I always end up sketching in a few classes and then tearing them up and re-sketching, and after a few iterations I’m starting to have a feeling for X and Y.
  • I freely admit that this is not really truly TDD
  • once you’re into maintenance mode, there are really no excuses. Because you really know what all your X’s and Y’s are
  • Writing the tests points out all the mistakes you might make in signatures, prerequisites, etc. If the tests are too hard to make then you know that your API will be too hard to use, you're doing it completely wrong, and may as well pause for a rethink.
  • While the approach you advocate makes sense, it does require professionalism, not just from the developer but from management too.
  • the person left to maintain the code isn't the person who wrote it, leaving the maintainer with an unholy mess to untangle. Getting unit tests into such code is a monumental task.
  • he failure to address how unit tests can be introduced to an existing non unit-test codebase. (i.e. go from non-TDD to TDD)
  • I feel the TDD community only wants to focus on greenfield projects and has ignored maintenance/legacy issues. Which is strange when as you say code spends most of it's time in maintenance
  • The thing is that as long as the project is small you really don't see the benefits of TDD. I've done a couple of small projects and never had to go back to them ever again
  • Never use mocks unless you are mocking an interface that will almost never change
  • You are writing the client code (in the form of a test) so you are thinking how the worker code will be used. What is its public interface and what do you want it to do when it's called
  • From: Tathagata Chakraborty (Jun 24 2009, at 07:31)TDD is useful in another situation - in a commercial setting and when detailed specification documents have already been created by say a technical expert/architect. In this case you don't have to do a lot of designing while coding, so you can start off with the test cases.
  • writing the tests *first* is that it helps keep your code focused on exactly what it's meant to do, and no more
  • When work on production code begins, most of the code should fall into the categories of things that are not to be tested.
  • In theory, TDD is a great idea. The problem with TDD can be expressed in one word: money.
  • One approach to the unknown X and Y problem that I've been using recently has been to pretend that class X has been written already, and then write code that uses this pretend X object/API. I usually write this directly in the file that will become my unit test. Since X doesn't exist, I'm allowed to call whatever methods I want and pretend it all works. Once I'm satisfied with how it all looks, I cut and paste everything into a bunch of failing tests.
  • I get really bored adding tests to code that already runs
  • the seductive TDD trap
  • religious zealots
  • There is nothing wrong with building tests after you have built your product.
  • that goes a long way towards taking software development from a form of artisanal craftsmanship to a real engineering profession.
  • using tests to drive development cripples innovation, dramatically slows development
  • It always seem to me to be a codified form of reverse engineering, or at least a way to force the programmers into looking at their code from two separate angles at the same time.
  • If you're just adding tests at the end, then it's normal unit-testing, isn't it?
  • I do realize that this type of exercise might help younger coders in getting better structure, they do often rush in too quickly and focus more on the instructions than the abstractions.
  • TDD is test-driven *design*
  • He said he didn't write tests in cases where it would have taken him several hours to get a working test for a small piece of code.
  • In some applications, objects are self-contained, activities are sequential, and algorithms are tricky
  • I've seen cases where people have wrecked the architecture of systems in the name of making them testable... But have never written the tests.
  • Yes, it's possible to make peace with testability, and in the best situation, testability can improve the architecture of a program, but it can also lead people away from highly reliable and maintainable KISS approaches.
  • Like any infrastructure, it is always beneficial to provide unit testing. The most benefit is derived from installing it as early on in the project as possible.
  • The value of an untested feature, to a client, is ... zero. So, it doesn't matter how many of these you have rattled off in the past week, your net throughput is effectively... zero."
  • You can see in this thread the word "professionalism" (substitute "morality" with little gain/loss of substance) and even "sin" (used in jest, but not really!)
  • if I delay writing unit tests until after all the units are working together then because the system "already works" my subconscious enthusiasm for writing unit tests falls markedly, and so their quality and coverage fall
  • Experience teaches that if I generate that output by hand (1) it takes *much* longer (2) I almost always get it wrong. So I often write the code, get its output, carefully check it (really...) and then use it as the correct result.
  • My main objections to TDD are: 1) it promotes micro-design over macro-design and 2) it's hard to apply in practice (i.e. for any code that is not a bowling card calculator or a stack).
  • the tests are just a persistent artifact of the exploratory coding I've already done.
Sarah HL

Brendel Consulting - 0 views

  • "I don't want to write comments, because then I will have to scroll more to see the code.""Writing comments in the code takes time."Formatting the code nicely takes time, especially when I need to change a few things, in which case I then have to re-format the code."Code changes, and before you know it the comments are obsolete."
  • Meaningful variable and function names
  • Thoughtful source code documentation.
  • ...1 more annotation...
  • A legible and consistent coding style.
qualitypoint Tech

Groupit Document - 0 views

  •  
    Groupit is a learning activity.Using this game the user can match information card with the correct category. There will be an unlimited number of cards and minimum of eight categories are added.During the game the total number of cards, mistakes and elapsed time are calculated and then it will be displayed after end of the game.
Sarah HL

The 7 Rules for Writing World Class Technical Documentation - Developer.com - 1 views

  • Dry sucks Before you start, be clear about what you want your reader to do after you end Write to a well formed outline, always Avoid ambiguous pronouns clarity = illustrations + words When dealing with concepts... logical illustration and example Embrace revision
cecilia marie

Remote PC Support: Convenient and Fast - 1 views

I was visiting my grandparents in the country one day. They own a personal computer at their house which they usually use for making important documents. One one of our visits, I used it to check m...

remote pc support

started by cecilia marie on 04 Nov 11 no follow-up yet
Bensan George

Zend Framework: Documentation: Zend_Db_Select - Zend Framework Manual - 2 views

  •  
    zend db select
1 - 16 of 16
Showing 20 items per page