Logo
Logo
  • Home
  • About
  • Services
    • Fractional CTO
    • Application Architecture
    • Platform Audits
    • Platform Rebuilds
  • Projects
  • Writing
  • Work
  • Request Quote
Logo

Backed by 20+ years of hands-on software development expertise, mithra62 transforms ideas into powerful, reliable solutions—designed to work exactly how you want, every time.

  • Address

    Tucson, AZ 85712
  • Email

    eric@mithra62.com
  • Contact

    +1-310-739-3322

phpdocumentor cheat sheet

  • Home
  • Writing
phpdocumentor cheat sheet
16 Nov 08
  • Programming

I've been documenting my code in phpdoc style for a while and have compiled a cheat sheet of common tasks and cheats.

To process a given directory use the following:

phpdoc -o HTML:frames:default, HTML:Smarty:PHP, HTML:frames:phpedit, PDF:default:default, CHM:default:*, HTML:frames:phphtmllib, HTML:frames:l0l33t, HTML:frames:earthli -t /Path/To/Storage/Directory -d/Path/To/Directory/To/Parse

For a full outline of all available command options

A list of default tags:

* @abstract
* @access       public or private
* @author       author name <author@email>
* @copyright    name date
* @deprecated   description
* @deprec       alias for deprecated
* @example      /path/to/example
* @exception    Javadoc-compatible, use as needed
* @global       type $globalvarname
or
* @global       type description of global variable usage in a function
* @ignore
* @internal     private information for advanced developers only
* @param        type  description
* @return       type description
* @link         URL
* @name         procpagealias
or
* @name         $globalvaralias
* @magic        phpdoc.de compatibility
* @package      package name
* @see          name of another element that can be documented,
*                produces a link to it in the documentation
* @since        a version or a date
* @static
* @staticvar    type description of static variable usage in a function
* @subpackage    sub package name, groupings inside of a project
* @throws       Javadoc-compatible, use as needed
* @todo         phpdoc.de compatibility
* @var        type    a data type for a class variable
* @version    version

Want to get in touch and let me know how I can help you with your project?

Get Started

Recent Post

  • Your Platform Isn’t Slow. It’s Misaligned.
    Your Platform Isn’t Slow. It’s Misaligned.
    14 Apr, 2026
  • How Teams Accidentally Build Failure
    How Teams Accidentally Build Failure
    07 Apr, 2026
  • You Don’t Need More Developers. You Need Less… Whatever This Is.
    You Don’t Need More Developers. You Need Less… Whatever This Is.
    31 Mar, 2026

follow us

Logo

Backed by 20+ years of hands-on software development expertise, mithra62 (Eric Lamb) transforms ideas into powerful, reliable solutions designed to work exactly how you want, every time.

© Copyright 2026 | mithra62

Useful Links

  • About
  • Projects
  • Writing
  • Work
  • Request Quote

Services

  • Fractional CTO
  • Application Architecture
  • Platform Audits
  • Platform Rebuilds

Contact Info

Get in touch now to begin work immediately.

  • Email: eric@mithra62.com
  • Contact: 310.739.3322