title: Comments for PHP class and functions
body: <p>I would like to add some documentation comments for my (PHP) class and its functions in some standard format, so that it’s easier for others to understand.</p>
  <p>What would an example of how you would write comments for the following class and function?</p>
  <p>Information about the class:</p>
  <p>Classname Photos: it has some functions related to uploading the photo and displaying the photos. Function names are <code>upload()</code>, <code>display()</code>, <code>delete()</code>.</p>
  <p>Information about the upload function:</p>
  <p>Uploads the resizes and uploads the image and has few parameters as shown below.</p>
  <pre class="lang-none prettyprint-override"><code>&lt;?php
      class Photos extends CI_Controller
      {
          public function upload($file_name, $new_name, $new_width, $new_height, $directory)
          {
              ...
              ...
              returns true or false.
          }
  
  ?&gt;
  </code></pre>