Created
December 9, 2017 12:37
-
-
Save jvadillo/4bc92fe084d8ed9837e4733710eb7147 to your computer and use it in GitHub Desktop.
PHP Comments
This file contains 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
Functions: | |
/** | |
* Does something interesting | |
* | |
* @param Place $where Where something interesting takes place | |
* @param integer $repeat How many times something interesting should happen | |
* | |
* @throws Some_Exception_Class If something interesting cannot happen | |
* @author Monkey Coder <mcoder@facebook.com> | |
* @return Status | |
*/ | |
Classes: | |
/** | |
* Short description for class | |
* | |
* Long description for class (if any)... | |
* | |
* @copyright 2006 Zend Technologies | |
* @license http://www.zend.com/license/3_0.txt PHP License 3.0 | |
* @version Release: @package_version@ | |
* @link http://dev.zend.com/package/PackageName | |
* @since Class available since Release 1.2.0 | |
*/ | |
Fichero completo: | |
/** | |
* Short description for file | |
* | |
* Long description for file (if any)... | |
* | |
* PHP version 5.6 | |
* | |
* LICENSE: This source file is subject to version 3.01 of the PHP license | |
* that is available through the world-wide-web at the following URI: | |
* http://www.php.net/license/3_01.txt. If you did not receive a copy of | |
* the PHP License and are unable to obtain it through the web, please | |
* send a note to license@php.net so we can mail you a copy immediately. | |
* | |
* @category CategoryName | |
* @package PackageName | |
* @author Original Author <author@example.com> | |
* @author Another Author <another@example.com> | |
* @copyright 1997-2005 The PHP Group | |
* @license http://www.php.net/license/3_01.txt PHP License 3.01 | |
* @version SVN: $Id$ | |
* @link http://pear.php.net/package/PackageName | |
* @see NetOther, Net_Sample::Net_Sample() | |
* @since File available since Release 1.2.0 | |
* @deprecated File deprecated in Release 2.0.0 | |
*/ | |
/** | |
* This is a "Docblock Comment," also known as a "docblock." The class' | |
* docblock, below, contains a complete description of how to write these. | |
*/ | |
require_once 'PEAR.php'; | |
/** | |
* Methods return this if they succeed | |
*/ | |
define('NET_SAMPLE_OK', 1); | |
/** | |
* The number of objects created | |
* @global int $GLOBALS['_NET_SAMPLE_Count'] | |
*/ | |
$GLOBALS['_NET_SAMPLE_Count'] = 0; | |
/** | |
* An example of how to write code to PEAR's standards | |
* | |
* Docblock comments start with "/**" at the top. Notice how the "/" | |
* lines up with the normal indenting and the asterisks on subsequent rows | |
* are in line with the first asterisk. The last line of comment text | |
* should be immediately followed on the next line by the closing asterisk | |
* and slash and then the item you are commenting on should be on the next | |
* line below that. Don't add extra lines. Please put a blank line | |
* between paragraphs as well as between the end of the description and | |
* the start of the @tags. Wrap comments before 80 columns in order to | |
* ease readability for a wide variety of users. | |
* | |
* The Javadoc Style Guide is an excellent resource for figuring out | |
* how to say what needs to be said in docblock comments. Much of what is | |
* written here is a summary of what is found there, though there are some | |
* cases where what's said here overrides what is said there. | |
* http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#styleguide | |
* | |
* @category CategoryName | |
* @package PackageName | |
* @author Original Author <author@example.com> | |
* @author Another Author <another@example.com> | |
* @copyright 1997-2005 The PHP Group | |
* @license http://www.php.net/license/3_01.txt PHP License 3.01 | |
* @version Release: @package_version@ | |
* @link http://pear.php.net/package/PackageName | |
* @see NetOther, Net_Sample::Net_Sample() | |
* @since Class available since Release 1.2.0 | |
* @deprecated Class deprecated in Release 2.0.0 | |
*/ | |
class Net_Sample | |
{ | |
/** | |
* The status of foo's universe | |
* Potential values are 'good', 'fair', 'poor' and 'unknown'. | |
* @var string $foo | |
*/ | |
public $foo = 'unknown'; | |
/** | |
* The status of life | |
* Note that names of private properties or methods must be | |
* preceeded by an underscore. | |
* @var bool $_good | |
*/ | |
private $_good = true; | |
/** | |
* Registers the status of foo's universe | |
* | |
* Summaries for methods should use 3rd person declarative rather | |
* than 2nd person imperative, beginning with a verb phrase. | |
* | |
* | |
* Here is an example for non-php example or sample: | |
* <samp> | |
* pear install net_sample | |
* </samp> | |
* | |
* @param string $arg1 the string to quote | |
* @param int $arg2 an integer of how many problems happened. | |
* Indent to the description's starting point | |
* for long ones. | |
* | |
* @return int the integer of the set mode used. FALSE if foo | |
* foo could not be set. | |
* @throws exceptionclass [description] | |
* | |
* @access public | |
* @static | |
* @see Net_Sample::$foo, Net_Other::someMethod() | |
* @since Method available since Release 1.2.0 | |
* @deprecated Method deprecated in Release 2.0.0 | |
*/ | |
function setFoo($arg1, $arg2 = 0) | |
{ | |
/* | |
* This is a "Block Comment." The format is the same as | |
* Docblock Comments except there is only one asterisk at the | |
* top. phpDocumentor doesn't parse these. | |
*/ | |
if ($arg1 == 'good' || $arg1 == 'fair') { | |
$this->foo = $arg1; | |
return 1; | |
} elseif ($arg1 == 'poor' && $arg2 > 1) { | |
$this->foo = 'poor'; | |
return 2; | |
} else { | |
return false; | |
} | |
} | |
// }}} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment