Skip to content

Add Java comments docs #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/navs/documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ export const documentationNav = {
pages['operators'],
pages['basic-input-output'],
pages['expressions-statements-blocks'],
pages['comments'],
],
}
100 changes: 100 additions & 0 deletions src/pages/docs/comments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
---
title: Java Comments
description: In this tutorial, you will learn about Java comments, why we use them, and how to use comments in right way.
---

import { Heading } from '@/components/Heading'
import Link from 'next/link'
import { TipInfo } from '@/components/Tip'


In computer programming, comments are a portion of the program that are completely ignored by Java compilers. They are mainly used to help programmers to understand the code. For example,

```java
// declare and initialize two variables
int a =1;
int b = 3;

// print the output
System.out.println("This is output");
```
Here, we have used the following comments,

- declare and initialize two variables
- print the output

## Types of Comments in Java

In Java, there are two types of comments:

- single-line comment
- multi-line comment

### Single-line Comment

A single-line comment starts and ends in the same line. To write a single-line comment, we can use the `//` symbol. For example,

```java
// "Hello, World!" program example

class Main {
public static void main(String[] args) {
{
// prints "Hello, World!"
System.out.println("Hello, World!");
}
}
```
Output:

```text
Hello, World!
```
Here, we have used two single-line comments:

- `"Hello, World!" program example`
- `prints "Hello World!"`

The Java compiler ignores everything from `//` to the end of line. Hence, it is also known as **End of Line** comment.

### Multi-line Comment

When we want to write comments in multiple lines, we can use the multi-line comment. To write multi-line comments, we can use the `/*....*/` symbol. For example,

```java
/* This is an example of multi-line comment.
* The program prints "Hello, World!" to the standard output.
*/

class HelloWorld {
public static void main(String[] args) {
{
System.out.println("Hello, World!");
}
}
```
Output:

```text
Hello, World!
```
Here, we have used the multi-line comment:

```java
/* This is an example of multi-line comment.
* The program prints "Hello, World!" to the standard output.
*/
```
This type of comment is also known as **Traditional Comment**. In this type of comment, the Java compiler ignores everything from `/*` to `*/`.

## Use Comments the Right Way

One thing you should always consider that comments shouldn't be the substitute for a way to explain poorly written code in English. You should always write well structured and self explaining code. And, then use comments.

Some believe that code should be self-describing and comments should be rarely used. However, in my personal opinion, there is nothing wrong with using comments. We can use comments to explain complex algorithms, regex or scenarios where we have to choose one technique among different technique to solve problems.

<TipInfo>

**Note:** In most cases, always use comments to explain **'why'** rather than **'how'** and you are good to go.

</TipInfo>
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy