Comments in JAVA language

-
Java comments :
Single line comments :

The purpose of including comments in your code is to explain what the code is doing.
Java supports both single and multi-line comments. All characters that appear within a comment are ignored by the Java compiler.

A single-line comment starts with two forward slashes and continues until it reaches the end of the line.
For example:

// this is a single-line comment
x = 5; // a single-line comment after code

Multi-Line comments
:

Java also supports comments that span multiple lines.
You start this type of comment with a forward slash followed by an asterisk, and end it with an asterisk followed by a forward slash.
For example:

/*  This is also a
    comment spanning
    multiple lines */

Note that Java does not support nested multi-line comments.
However, you can nest single-line comments within multi-line comments.

/* This is a single-line comment:
    // a single-line comment
 */

Documentation comments
:

Documentation comments are special comments that have the appearance of multi-line comments, with the difference being that they generate external documentation of your source code. These begin with a forward slash followed by two asterisks, and end with an asterisk followed by a forward slash.
For example:

/** This is a documentation comment */
/** This is also a
    documentation comment */

Javadoc is a tool which comes with JDK and it is used for generating Java code documentation in HTML format from Java source code which has required documentation in a predefined format.

When a documentation comment begins with more than two asterisks, Javadoc assumes that you want to create a "box" around the comment in the source code. It simply ignores the extra asterisks.
For example:

/**********************
This is the start of a method
***********************/

Comments

Post a Comment

Popular posts from this blog

Addition 2 number in C Language

-
Image
Sample Program : Addition of two numbers Consider the program, which performs addition on two numbers and displays the result. The program is following : This program when executed will product the following output : 100 106.10 The first two lines of the program are comment lines. It is a good practice to use comment lines in the beginning to give information such as name of the program, author, date etc. Comment characters are also used in other lines to indicate line numbers. The words number and amount are variable names that are used to store numeric data. The numeric data may be either in integer form or in real form. In C, all variables should be declared to tell the compiler what the variable names are and what type of data they hold. The variables must be declared before they are used. In lines 5 and 6, the declarations : int number; float amount; tell the compiler that number is an integer( int ) and amount is a floating( float...
Read more

Input and Output in C

-
Input : C supports a number of ways for taking user input. getchar() Returns the value of the next single character input. For example : #include <stdio.h> int main()  {   char a = getchar();   printf("You entered: %c", a);   return 0; } The input is stored in the variable a. The gets() function is used to read input as an ordered sequence of characters, also called a string. A string is stored in a char array. For example :  #include <stdio.h> int main()  {   char a[100];   gets(a);   printf("You entered: %s", a);   return 0; } Here we stored the input in an array of 100 characters. scanf() scans input that matches format specifiers. For example : #include <stdio.h> int main()  {   int a;   printf("Please enter an element : ", a);   scanf("%d", &a);    return 0; } The " &" sign before the variable name is th...
Read more

Comments in C

-
Comments : Comments are explanatory information that you can include in a program to benefit the reader of your code. The compiler ignores comments, so they have no affect on a program. A comment starts with a slash asterisk /* and ends with an asterisk slash */ and can be anywhere in your code. Comments can be on the same line as a statement, or they can span several lines. For example: #include <stdio.h> /* A simple C program  * Version 1.0  */ int main() {   /* Output a string */   printf("Hello World!");   return 0; } Note :  As you can see, comments clarify the program's intent to the reader. Use comments to clarify the purpose and logic behind segments of code. Single-line Comments :  C++ introduced a double slash comment // as a way to comment single lines. Some C compilers also support this comment style. For example:  #include <stdio.h> int main() {   int x = 42; //int for a who...
Read more