Lecture10JavaDocs.java

import java.util.Scanner;
/**
 * This is a javadocs block, begins with forward slash + two asterisks
 * We insert a javadocs block for every class and every method
 * 
 * In here we explain what our class is doing, what it is for, sometimes
 * why we coded it
 * 
 * For classes we put:
 * @author Author Name Here
 * @version date here format yyyy-mm-dd
 * 
 */
public class Lecture10JavaDocs {
  public static void main(String[] args) {
    /*
     * this is a multi line comment, begins with forward slash + one asterisk
     * you must end it with one asterisk + forward slash
     * 
     * make it easy to read
     */
  }
  /**
   * This is a javadocs block, begins with forward slash + two asterisks
   * We insert a javadocs block for every class and every method
   * 
   * In here we explain what our method is doing, what it is for, sometimes
   * why we coded it & any references we may want 
   * 
   * @param param1      desciption of parameter
   * @param param2      desciption of parameter
   * 
   * @return datatype   description of what is returned by this method
   * 
   * @author PCampbell
   * @version 2020-10-05
   */
  public static double bestMethodEver(double param1, int param2) {
    // this is a single inline comment
    return 5.5;     // this is an inline comment
  }
}