Professional PHP

PHP Programming, Web Development, PHP Advocacy and PHP Best Practices.

On the Perils of Inline API Documentation

April 13th, 2007

Travis Swicegood has a post questioning the value of the docblock. I have a deep sympathy with this sentiment.
Even on projects with extensive generated documentation, I find that kind of documentation to be of extremely low value. The problem with inline API documentation is that there is no sense of priority. Developers [...]

13 Comments | Read the full post »

PDO Design Evolution

October 23rd, 2004

Alan Knowles has an interesting post on PDO.
I really don’t know much about PDO, i haven’t used it yet. Most of what I know comes from:
Wez Furlong’s first steps with PDO examples
Wez’s Oracle PDO Article
John Lim’s discussion of adodb and PDO
A sitepoint thread on PDO
I haven’t seen any API type docs yet. I [...]

1 Comment | Read the full post »

Evolution not Revolution

June 18th, 2004

I ran across an Interview with Scott Collins about Mozilla at ArsTechnica. In light of Joel Spolsky’s How Microsoft Lost the API War article, I found one comment particularly interesting:
And we didn’t get out a 5.0, and that cost of us everything, it was the biggest mistake ever
This was obviously an emotional issue for Scott, [...]

1 Comment | Read the full post »

API Design

May 5th, 2004

I ran across a couple older items on API design: Words of Wisdom on Designing Usable APIs and Think of Objects as Machines.
good API designs happens when designers think of … client programmers as users.
I wish more developers took this to heart. I’ll add my own law of API design:
Good API design makes common [...]

6 Comments | Read the full post »

    Subscribe Feed
    Share Subscribe to this blog…
    Share Bookmark or share this page…
  • About

    My name is Jeff Moore. I'm a PHP programmer living in San Francico and working for a startup.

    More about me…

  • Categories (Home)

    • Agile Methods (14)
    • Mac (14)
    • Misc (17)
    • Open Source (14)
    • PHP (98)
    • Software Design (29)
    • Usability (14)
    • Web Design (20)
  • Recent Comments

    • Looking Towards the Cloud  23
      Betty Saletta, Driver License, Jamel Sawyer [...]
    • Benchmarking PHP's Magic Methods  12
      Article Marketing Strategy, Magento Development, Vance Lucas [...]
    • Improved Error Messages in PHP 5  32
      Terry Nessel, css, Amsterdam [...]
    • Keywords and Language Simplicity  11
      kim kardashian sex tape price, nokia, per Rechnung bestellen [...]
    • flickr case study  3
      bookmarking demon software, php-trivandrum.org, Harry Fuecks
    • rsync to remote server via ssh  7
      Burton Haynes, James, Mike [...]
    • Yahoo YUI wins JavaScript Library Wars  10
      Lera Bride, Scott, Jeff [...]
    • OOP is Mature, not Dead  15
      Avery Depew, Fernando, deltawing [...]
    • Ruby versus PHP or There and Back Again  10
      Solar Pumps, Amsterdam, Hari K T [...]
    • ZendCon: Writing Maintainable PHP Code  8
      IT Ninja, nicopico, Arif [...]
  • Site

    • Archives
    • Log in
  • Search