Inline Documentation

From 워드프레스(WORDPRESS) 한국어 위키

This page is the start of the effort to add inline documentation to the WordPress core code to aid in future development, improvements and changes, as well as to assist others when learning about PHP and WordPress.

Use of this page and subsequent child pages is meant for developing standard methodologies and formats, as well as to ensure that there is no duplication of effort.

Contents 1 Tags 2 WordPress PHP Cross Reference 3 cool examples 4 Resources 5 Work In Progress 6 List of Files

Tags

Here are some tags that we could use

@param  	type	$varname	description
@return 	type	description
@deprecated	description
@deprec		alias for deprecated
@todo		description of what todo
@var		type	a data type for a class variable

At aptana.tv there is a video showing the power of proper inline documentation. Some tags are really helpful as you can see there.

WordPress PHP Cross Reference

• English Version
• German Version
• Alpha Version

cool examples

• jQuery shows how cool a good inline-documentation could be. The official API docu is XML generated from the code-files. There is a second view of the docu with more visual style.

Resources

• phpDocumentor - Auto-documentation tool for php language (phpdoc.org)
• phpDocumentor Tutorial - How to use phpDocumentor (phpdoc.org)
• PEAR sample A complete sample for doc comments
• Zend Studio - PHP Development Environment (commercial product)
• Hacker's List Inline Documentation discussion
• Hacker's List PATCH Documentation discussion

Work In Progress

• wp-includes/wpdb.php - Complete (Robert Deaton) - http://trac.wordpress.org/ticket/2474

• wp-includes/functions-post.php - Started (Scott Merrill) - http://trac.wordpress.org/ticket/2473

• wp-includes/pluggable-functions.php - Complete (Robert Deaton) - http://trac.wordpress.org/ticket/2477

• wp-includes/comment-functions.php - Started (Peter Walker) - http://trac.wordpress.org/ticket/2648

List of Files

• wp-admin/
  • images/
    • snip
  • import/
    • b2.php
    • blogger.php
    • dotclear.php
    • greymatter.php
    • livejournal.php
    • mt.php
    • rss.php
    • textpattern.php
  • admin-db.php
  • admin-footer.php
  • admin-functions.php
  • admin-header.php
  • admin.php
  • bookmarklet.php
  • cat-js.php
  • categories.php
  • edit-comments.php
  • edit-form-advanced.php
  • edit-form-ajax-cat.php
  • edit-form-comment.php
  • edit-form.php
  • edit-link-form.php
  • edit-page-form.php
  • edit-pages.php
  • edit.php
  • execute-pings.php
  • import.php
  • index.php
  • inline-uploading.php
  • install-helper.php
  • install.php
  • link-add.php
  • link-categories.php
  • link-import.php
  • link-manager.php
  • link-parse-opml.php
  • list-manipulation.js
  • list-manipulation.php
  • menu-header.php
  • menu.php
  • moderation.php
  • options-discussion.php
  • options-general.php
  • options-head.php
  • options-misc.php
  • options-permalink.php
  • options-reading.php
  • options-writing.php
  • options.php
  • page-new.php
  • plugin-editor.php
  • plugins.php
  • post.php
  • profile-update.php
  • profile.php
  • setup-config.php
  • sidebar.php
  • templates.php
  • theme-editor.php
  • themes.php
  • update-links.php
  • upgrade-functions.php
  • upgrade-schema.php
  • upgrade.php
  • user-edit.php
  • users.php
  • wp-admin.css
  • xfn.js
• wp-content/
  • plugins/
    • hello.php
    • wp-db-backup.php
  • themes/
    • classic/
      • snip
    • default/
      • snip
  • index.php
• wp-includes/
  • images/
    • snip
  • js/
    • snip
  • cache.php
  • capabilities.php
  • class-IXR.php
  • class-pop3.php
  • class-snoopy.php
  • classes.php
  • comment-functions.php
  • default-filters.php
  • feed-functions.php
  • functions-compat.php
  • functions-formatting.php
  • functions-post.php
  • functions.php
  • gettext.php
  • kses.php
  • links.php
  • locale.php
  • pluggable-functions.php
  • registration-functions.php
  • rss-functions.php
  • streams.php
  • template-functions-author.php
  • template-functions-category.php
  • template-functions-general.php
  • template-functions-links.php
  • template-functions-post.php
  • template-loader.php
  • vars.php
  • version.php
  • wp-db.php
  • wp-l10n.php
• index.php
• license.txt
• readme.html
• wp-atom.php
• wp-blog-header.php
• wp-comments-post.php
• wp-commentsrss2.php
• wp-config-sample.php
• wp-feed.php
• wp-links-opml.php
• wp-login.php
• wp-mail.php
• wp-pass.php
• wp-rdf.php
• wp-register.php
• wp-rss.php
• wp-rss2.php
• wp-settings.php
• wp-trackback.php
• xmlrpc.php