[Tự học Java] Comment trong Java

Trong bài viết này, bạn sẽ tìm hiểu về comments trong Java, tại sao phải sử dụng chúng và cách sử dụng chúng.

Trong lập trình, comments là một phần của chương trình giúp cho bạn cũng như các lập trình viên khác hiểu được code. Comments bị trình biên dịch trong Java bỏ qua hoàn toàn. Ví dụ

/**
* Cafedev.vn - Kênh thông tin IT hàng đầu Việt Nam
*
* @author cafedevn
* Contact: cafedevn@gmail.com
* Fanpage: https://www.facebook.com/cafedevn
* Instagram: https://instagram.com/cafedevn
* Twitter: https://twitter.com/CafedeVn
* Linkedin: https://www.linkedin.com/in/cafe-dev-407054199/
*/

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

// print the output
System.out.println("This is output");

Trong ví dụ trên, chúng ta đã sử dụng 2 comment sau:

• declare and initialize two variables
• print the output

Trong ngôn ngữ lập trình Java, có hai loại comment:

• /* … */
• // ….

1. Comment thường / * … * /

Đây là comment nhiều dòng và tất nhiên là có thể trải dài trên nhiều dòng. Trình biên dịch trong Java bỏ qua những gì được viết trong đoạn từ /* đến */. Ví dụ,

/**
* Cafedev.vn - Kênh thông tin IT hàng đầu Việt Nam
*
* @author cafedevn
* Contact: cafedevn@gmail.com
* Fanpage: https://www.facebook.com/cafedevn
* Instagram: https://instagram.com/cafedevn
* Twitter: https://twitter.com/CafedeVn
* Linkedin: https://www.linkedin.com/in/cafe-dev-407054199/
*/

/* 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

Hello, World!

Ở đây, comment là:

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

2. Comment 1 dòng //

Trình biên dịch bỏ qua mọi thứ từ // đến cuối dòng. Ví dụ,

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

Output

Hello, World!

Chương trình trên có hai comment 1 dòng:

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

3. Sử dụng comments đúng cách

Không nên dùng comments để giải thích những đoạn code thiếu chuyên nghiệp. Hãy viết code có cấu trúc tốt và dễ đọc, sau đó hãy dùng comments.

Một số người nói code nên là bầy tỏ hết ý nghĩa của nó và nên hạn chế việc sử dụng comments. Tuy nhiên, tôi không hoàn toàn đồng ý với điều này (Theo ý kiến ​​cá nhân của tôi). Không có gì sai với việc sử dụng comments để giải thích các thuật toán, biểu thức chính quy hoặc các script phức tạp cũng như để giải thích tại sao dùng cách này để giải quyết vấn đề sẽ tốt hơn dùng cách kia,v.v.

Tóm lại, hãy sử dụng comments để giải thích ‘tại sao’ thay vì giải thích ‘làm thế nào’.