phpDoc Cheatsheet, because documenting code is fun!

posted July 6th, 2007 at 6:26 pm by chad

Okay, maybe I exagerate a bit, but if you're developing PHP that others need to decipher, commenting your code is a must. Heck, I'm finding that code documentation for myself is a saving grace when revisiting what I've written months, or even a week later. So, to help you and I, I've created a phpDoc cheatsheet that's ready to download in either PDF or PNG format.

AttachmentSize
phpdoc_cheatsheet.pdf140.55 KB
phpdoc_cheatsheet.png269.11 KB

Comments

Post new comment

The content of this field is kept private and will not be shown publicly. If you have a Gravatar account associated with the e-mail address you provide, it will be used to display your avatar.
  • Web page addresses and e-mail addresses turn into links automatically.
  • Allowed HTML tags: <a> <em> <strong> <cite> <code> <ul> <ol> <li> <dl> <dt> <dd> <codeblock> <blockquote> <h1> <h2> <h3> <h4> <h5> <img>
  • Lines and paragraphs break automatically.
  • You may link to webpages through the weblinks registry
  • Syntax highlight code surrounded by the {syntaxhighlighter SPEC}...{/syntaxhighlighter} tags, where SPEC is a Syntaxhighlighter options string or "class="OPTIONS" title="the title".

More information about formatting options

CAPTCHA
This question is for testing whether you are a human visitor and to prevent automated spam submissions.
copyright © 2011, 2 tablespoons