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

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 othe...
Read more

Java Basics - Errors

Syntax errors (Compile-time error) -Violation of Java's grammatical rules -Will not compile Runtime errors -Happens while programming is running -Will Cause the program to crash Bugs (logical) -Program that just does not do what you expect.
Read more

Java Basics - Arrays 1

Arrays  Arrays allow us to store many variables or strings in one place. For example month[0] = "January"; month[1] = "February"; month[2] = "March"; We can add numbers as well int number[0] =1; int number[1] = 5; int sum = number[0] and number [1]; //sum = 6; How do we declare an array int [] numbers {12,-2,4,6,-9,0,2}; double[] numbers {12.896,-2,4,6,-9.2,0,2};
Read more