The Artima Developer Community
Articles | News | Weblogs | Books | Forums
Artima Forums | Articles | Weblogs | Java Answers | News
Sponsored Link •

PHP Buzz Forum
On the Perils of Inline API Documentation

0 replies on 1 page.

Welcome Guest
  Sign In

Go back to the topic listing  Back to Topic List Click to reply to this topic  Reply to this Topic Click to search messages in this forum  Search Forum Click for a threaded view of the topic  Threaded View   
Previous Topic   Next Topic
Flat View: This topic has 0 replies on 1 page
Jeff Moore

Posts: 114
Nickname: selkirk
Registered: May, 2004

Jeff Moore is exploring PHP, open source, and design patterns.
On the Perils of Inline API Documentation Posted: Apr 13, 2007 9:26 AM
Reply to this message Reply

This post originated from an RSS feed registered with PHP Buzz by Jeff Moore.
Original Post: On the Perils of Inline API Documentation
Feed Title: Professional PHP
Feed URL: http://www.procata.com/blog/archives/category/php/feed/
Feed Description: Web Development with PHP, PHP Advocacy and Best Practices. 		Latest PHP Buzz Posts
Latest PHP Buzz Posts by Jeff Moore
Latest Posts From Professional PHP

Advertisement
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 [...]

Read: On the Perils of Inline API Documentation

Topic: Why PHP 5 Previous Topic   Next Topic Topic: Markup Separation with Template IT
Sponsored Links


Google
  Web Artima.com   

Copyright © 1996-2019 Artima, Inc. All Rights Reserved. - Privacy Policy - Terms of Use