Created
March 9, 2013 22:22
-
-
Save chrisvogt/5126023 to your computer and use it in GitHub Desktop.
A PHP comment style guide.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| <?php // app/controllers/really_awesome_controller.php | |
| /** | |
| * Awesome Controller Name | |
| * | |
| * This does something really awesome, and nifty too! | |
| * | |
| * @package CakePHP | |
| * @subpackage Super-Cool-Application | |
| * @author Chris Vogt ([email protected]) | |
| * @since 1.1.4 | |
| */ | |
| #### Dividers | |
| ## Major Divider with section name | |
| /* ▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀▄▀ | |
| * | |
| * :actions | |
| */ | |
| ## Small, kind of wonky divider | |
| /* _,.-'~'-.,__,.-'~'-.,__,.-'~'-.,__,.-'~'-.,__,.-'~'-.,__,.-'~'-.._ */ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment