Java Basic - Function 3

 Java Documentation

Java documentation lets us know about functions that java has built in and already recognizes.

It tells us about function descriptions, variable types and how to use them.

Java is owned  by Oracle and they contain all the documentation online.

It is the holy bible that all java developers use.

Lets create out own Java documentation below.

The usual basic documentation is as follow:

/**
*General description of a function
*
*@param a first input parameter, named a
*@param b second paramter, named b
*
*@return description of return value
*/

Now for a more real example eg dimension(double width, double depth, double height);
/**
*This volume function calculates the volume of a given rectangle by multiplying its sides
*
*@param width is the width dimension  (double)
*@param depth is the depth dimension  (double)
*@param height is the height dimension (double)
*
*@return volume  is the dimension (as a double)
*/

There is automatic software that can make this documentation.


Comments

Post a Comment

Popular posts from this blog

Java Basics - Variable and Data Types Part 1

Declaring and initializing a variables: int box; //declare variable type and name. box = 5;  //initialize variable Updating and setting avariable: box = box -3; //read from right to left //the box now is equal to the integer of 2, because  5-3=2 Displaying the above variable to the outside world: System.out.println(box); You can also declare and initialize in one statement: ie int price = 0; ________________________________________________ Declaring a String Variable: String driver; //declare driver = "Hamish" // Initialize Getting the length of the string int letter = driver.length(); Displaying the above variable to the outside world: System.out.println(letter); //Notethe out put would be 6. Changing to all upper case: driver = driver.toUpperCase(); //Now the string is "HAMISH" String Concatenation String firstName; firstName = "John"; String secondName; secondName = "Bloke"; String fullName = firstN
Read more

Java Basics - Variable and Data Types Part 2

Variable Types (numbers) Integer: int exampleVariable       //store (-) and (+) numbers that are small Long:    long exampleVariable   //store (-) and (+) numbers that are big Double: double exampleVariable //store fractions with decimal places Variable Types (text) String:          String = String fullText = "example"; Character:    char answer = 'b' or  char answer = '3'; Variable Types (decisions) Boolean: boolean fact = true;  //Can only have two values, true or false. Variable Arithmetic Addition: int x = 2+3    //=5 Subtraction: int y=5-2   //=3 Multiplication:  int days = 7*4 //= 28 Division:        double div =5/2 //=2                        double div = 5/2.0; //=2.5                          (Note: the 2.0 forces it to store the fractional part instead of throwing it away) Combining arithmetic variables. double paid = 10; double change = 3.25; double tip = (paid-change)*0.2 // Note here th
Read more

OOP - Objects and Classes

Classes Classes and objects are different terms Classes are an object type. You can create as many objects as you want of a class For example if a class has many fields and one of those is country, then an object would be Australia. In summary Objects are to Classes what Variables  are to Data types. For example  class Pokemon { String name;        //Field String type;         //Field int health;            //Field boolean dodge(){                        //Methods    return Math.random()>0.5; } } In Java each class should be created in its own file and have the extension ".java" For examples classes might be  vehicle.java   or map.java ________________________________________ The main method: This is where the program starts Inside it you can create objects and call methods to run other parts of your code. As defined by : public static void main (String [] args){ //start program here } //public : means you can run this method from any
Read more