HOME › java cơ bản cho người mới bắt đầu>>04. kiến thức cơ bản về java

Comment trong java

1 tháng 2 ,2021

Hướng dẫn cách comment trong java, hay còn gọi là cách chú thích trong java hoặc ghi chú trong java.Chúng ta sử dụng comment trong Java để chú thích nội dung của dòng code viết trong chương trình. comment trong Java sẽ không ảnh hưởng tới kết quả xử lý chương trình, do đó chúng ta có thể tự do viết chúng. Có ba cách comment trong Java và bạn sẽ học chúng hoàn hảo sau bài viết này.

Comment trong Java là gì

Comment trong Java là các dòng code được bỏ qua khi chạy chương trình , nhằm giúp bạn lưu lại các thông tin khi viết chương trình như biến số này dùng làm gì, ai là người tạo và tạo ra lúc nào chẳng hạn. Chỉ cần viết comment trong Java theo những luật xác định thì dòng comment trong Java sẽ không ảnh hưởng tới kết quả chương trình.

Các thông tin cần thiết được lưu giữ bởi comment trong Java sẽ giúp bạn bảo trì chương trình dễ hơn, cũng như dễ chuyển giao lại dự án cho người khác hoặc là chia sẽ dự án cho nhiều người cùng làm.

Cách comment trong java

Cách comment trên một dòng trong java

Chúng ta sử dụng // để Để comment một dòng trong Java. Comment trong Java sẽ được tính từ vị trí bắt đầu // cho tới hết dòng.

//dòng comment

Chúng ta có thể bắt đầu comment bằng cách ghi // từ vị trí đầu dòng, hay ở giữa dòng đều được.

public static void main(String[] args) {
  int sum = 0;

  // Lặp lại 10 lần
  for (int i = 1; i <= 10; i++){
    sum = sum + i; //Cộng lần lượt một đơn vị
  }

  System.out.println(sum);
}

Trong ví dụ trên hai dòng dưới đây chính là Comment trong Java

// Lặp lại 10 lần
//Cộng lần lượt một đơn vị

Cách comment trên nhiều dòng trong java

Để comment trên nhiều dòng trong java, ngoài cách ghi vào đầu từng dòng dấu // như ở cách trên, thì chúng ta có thể dùng một cách đơn giản hơn nữa, đó là viết các dòng chú thích ở giữa cặp dấu /* và */ với cú pháp sau đây:

/*
dòng comment 1
dòng comment 2
…
*/

Chúng ta sử dụng cặp dấu /* và */ để comment trên nhiều dòng trong java như ví dụ sau đây:

public static void main(String[] args) {
  /*
  Ngày viết : 210304
  Tác giả : Kiyoshi
  */

  System.out.println("comment trong java");
}

Kết quả:

comment trong java

Javadoc Comment

Phương pháp comment thứ ba trong java là phương pháp dùng công cụ có tên là Javadoc- công cụ được sử dụng để tự động tạo một tài liệu từ các bình luận được viết trong một chương trình. Cú pháp cơ bản giống như đối với comment trên nhiều dòng trong java, nhưng chúng ta sẽ sử dụng cặp dấu / ** và */ thay cho /* và */.

/**
dòng comment 1
dòng comment 2
…
*/

Nếu bạn viết comment trong java ở định dạng này ngay trước khi khai báo class hoặc phương thức, Javadoc sẽ tự động tạo tài liệu cho lớp này.
Trong ảnh minh họa dưới đây, phần code được đặt giữa cặp dấu / ** và */ trong khung màu đỏ chính là tài liệu cho class CommentJava được khai báo sau đó.

Sử dụng comment để tạm thời ngừng chạy câu lệnh

Ngoài cách sử dụng comment trong java để lưu lại các thông tin cần thiết, bạn cũng có thể dùng comment để ngừng chạy một hoặc nhiều câu lệnh. Cách làm này gọi là comment out trong tiếng Anh, hay là コメントアウト trong tiếng Nhật.

Cách sử dụng comment để tạm thời ngừng chạy câu lệnh giống như ví dụ sau đây:

public static void main(String[] args) throws Exception {
  int price = 500;
  price = price * 2;
  System.out.println (price);
}

Nếu chạy chương trình trên, chúng ta sẽ có kết quả là:

Nếu chúng ta không muốn chạy dòng lệnh thứ 2 nữa, chúng ta có thể xoá nó. Tuy nhiên nếu chúng ta chỉ tạm thời không muốn chạy dòng lệnh này, hãy comment dòng lệnh thứ hai như sau:

public static void main(String[] args) throws Exception {
  int price = 500;
  //price = price * 2;
  System.out.println (price);
}

Khi đó dòng lệnh thứ hai bị ngưng chạy, do đó chỉ có dòng lệnh 1 và 3 được thực thi và kết quả trả về như sau:

Nếu sau đó chúng ta muốn tiếp tục chạy dòng code này, chỉ cần đơn giản bỏ đi dấu // trước nó là xong, mà không cần phải viết lại nó nữa.

Mã mẫu

Tiếp theo sau đây, hãy cùng thử sức với ví dụ sử dụng comment trong java như sau:

import java.util.*;

/**
 * CommentJava
 *
 * 2021.03.04
 */
 
public class CommentJava {
    public static void main(String[] args) throws Exception {  
      int sum = 0;

      // vòng lặp 10 lần
      for (int i = 1; i <= 10; i++){
        sum = sum + i;  // cộng thêm 1 giá trị
      }

      /*
       In tổng ra màn hình
       */
      System.out.println(sum);
    }
}

Hãy lưu file lại dưới tên CommentJava.java, sau đó tiến hành biên dịch chương trình:

javac CommentJava.java

Sau đó thực hiện chạy chương trình:

java CommentJava

Kết quả chương trình

Phím tắt comment trong Java

Tùy thuộc vào phần mềm viết code Java mà bạn dùng thì chúng ta sẽ có các cách dùng phím tắt khác nhau như dưới đây:

Phím tắt comment trong Notepad ++

Sau khi chọn các dòng code, chúng ta có thể sử dụng các tổ hợp phím sau để comment trong Notepad ++:

Ctrl + K: Chuyển vùng code được chọn thành comment
Ctrl + Q: Bỏ commet của vùng code được chọn

Phím tắt comment trong Visual Studio

Sau khi chọn các dòng code, chúng ta có thể sử dụng các tổ hợp phím sau để comment trong Visual Studio:

Ctrl + K + C: Chuyển vùng code được chọn thành comment
Ctrl + K + U: Bỏ commet của vùng code được chọn

Phím tắt comment trong Sublime text 3

Sau khi chọn các dòng code, chúng ta có thể sử dụng các tổ hợp phím sau để comment trong Sublime text 3:

Ctrl + /: Chuyển vùng code được chọn thành comment
Ctrl + Shift + /: Bỏ commet của vùng code được chọn

Tổng kết

Trên đây Kiyoshi đã hướng dẫn bạn cách comment trong java rồi. Để nắm rõ nội dung bài học hơn, bạn hãy thực hành viết lại các ví dụ của ngày hôm nay nhé.

Và hãy cùng tìm hiểu những kiến thức sâu hơn về java trong các bài học tiếp theo.