×

Welcome to TagMyCode

Please login or create account to add a snippet.
 

DocBlock Example

0
0
 
0
Language: PHP
Posted by: Sergio Vazquez II
Added: Feb 9, 2022 10:28 PM
Modified: Feb 9, 2022 10:41 PM
Views: 407
Tags: docblock
  1. /**
  2.  * Summary which must end with period or two line breaks.
  3.  *
  4.  * Optional longer description or discussion that may contain
  5.  * inline tags and some html markup.  See the sections below for
  6.  * more details on the possible tags and markup.  Separated by
  7.  * blank lines, this is used in page-level DocBlocks and in
  8.  * element-level DockBlocks when the element merits further discussion.
  9.  * Section may contain markdown
  10.  *
  11.  * @since version number  
  12.  * @param <type> <name> <description>
  13.  * @return <type> (What is being returned)
  14.  */
  15.  
  16.  /**
  17.  * Test for uppercase.
  18.  *
  19.  * @since version 0.2  
  20.  * @param string $my_word text to be tested
  21.  * @return bool false if not uppercase
  22.  */
  23. function is_caps($my_word)
  24. {
  25.         return ($my_word === strtoupper($my_word));
  26. }
  27.  

Write a comment

To post comments, please log in or register.