Comment trong java | Laptrinhcanban.com

HOME › >>

Comment trong java

Khi bạn muốn giải thích về mã code được viết trong chương trình, bạn có thể sử dụng các chú thích. Chú thích không ảnh hưởng đến việc thực thi chương trình, do đó bạn có thể tự do viết chúng. Trong Java hiện có 3 cách để viết chú thích. Dưới đây là một hướng dẫn về cách viết chú thích trong Java.

Cách viết chú thích

Khi bạn viết chương trình, bạn muốn ghi lại ghi chú về việc biến này được sử dụng cho mục đích gì, hoặc về người tạo ra lớp đã định nghĩa và ngày tạo khi bạn muốn. Chú thích được sử dụng trong trường hợp này. Nếu bạn tuân theo các quy tắc được định sẵn khi viết chú thích, chúng sẽ không ảnh hưởng đến việc thực thi chương trình. Java hiện có 3 cách viết chú thích, chúng ta sẽ kiểm tra chúng một cách tuần tự dưới đây.

Chú thích trên một dòng

Một trong những cách viết chú thích là chú thích trên một dòng sử dụng // . Từ nơi xuất hiện // trong chương trình đến cuối dòng đó sẽ được coi là chú thích.

// Viết chú thích

Bạn có thể viết dấu // ở đầu dòng, hoặc giữa dòng và bắt đầu chú thích từ vị trí đó cho tới phía bên phải của dòng lệnh.

int sum = 0;

// Lặp 10 lần
for (int i = 1; i <= 10; i++){
sum = sum + i; // Cộng các số theo thứ tự
}

System.out.println(sum);

Phần màu đỏ trong ví dụ trên được coi là chú thích.

Chú thích nhiều dòng

Một cách viết chú thích khác là chú thích nhiều dòng sử dụng /**/ . Từ nơi xuất hiện /* trong chương trình, đến nơi xuất hiện */ sẽ được coi là chú thích.

/* Viết chú thích */

Bạn cũng có thể bao gồm các dòng mới giữa /**/ , cho phép bạn viết chú thích trên nhiều dòng.

/*
Viết chú thích
Viết chú thích
Viết chú thích
*/

Ví dụ cụ thể:

int sum = 0;

/∗
Lặp 10 lần
Cộng giá trị của biến i mỗi lần lặp
In ra kết quả cuối cùng
∗/

for (int i = 1; i <= 10; i++){
sum = sum + i;
}

System.out.println(sum);

Phần màu đỏ trong ví dụ trên được coi là chú thích.

Sử dụng chú thích để tạo Javadoc

Một cách viết chú thích khác là sử dụng Javadoc khi bạn muốn tạo tài liệu tự động từ các chú thích trong chương trình. Định dạng cơ bản giống với việc viết chú thích trên nhiều dòng, nhưng thay vì sử dụng/**/ , bạn sử dụng /***/ .

/**
Viết chú thích
Viết chú thích
Viết chú thích
*/

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 /***/ trong khung màu đỏ chính là tài liệu cho class CommentJava được khai báo sau đó.

Javadoc java

Sử dụng comment để tạm thời ngừng chạ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, bạn cũng có thể dùng comment để ngừng chạ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 để tạm thời ngừng chạy câu lệnh giống như ví dụ sau đây:

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

// 1000

Sau khi chạy chương trình trên, chúng ta sẽ có kết quả là 1000.

Nếu chú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 dò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);
}

//500

Khi đó dòng lệnh thứ hai bị ngưng chạy, do đó chỉ có dòng lệnh 1 và 3 được thực thi và kết quả trả về chỉ là 500 mà thôi.

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

Bây giờ chúng ta sẽ thử nghiệm một chương trình ví dụ đơn giản. Sau khi bạn viết mã như sau trong trình soạn thảo văn bản, hãy lưu nó với tên JSample6-1.java .

/**
* JSample6_1
*
* 2021.02.11
*/
class JSample6_1{
public static void main(String[] args){
int sum = 0;

// Lặp 10 lần
for (int i = 1; i <= 10; i++){
sum = sum + i; // Cộng các số theo thứ tự
}

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

Tiến hành biên dịch:

javac -encoding UTF-8 JSample6_1.java

Sau đó, hãy chạy chương trình như sau:

java JSample6_1

Chú thích trong Java

Chúng ta đã sử dụng 3 cách để viết chú thích. Bất kỳ cách nào cũng không ảnh hưởng đến việc thực thi chương trình.

Tổng kết

Trên đây Kiyoshi đã giải thích đơn giản về 3 cách viết comment trong Java. Bất kỳ cách nào cũng không ảnh hưởng đến việc thực thi chương trình.

URL Link

https://laptrinhcanban.com/java/java-co-ban-cho-nguoi-moi-bat-dau/kien-thuc-co-ban-ve-java/comment-trong-java/

Hãy chia sẻ và cùng lan tỏa kiến thức lập trình Nhật Bản tại Việt Nam!

HOME  › >>

Profile
きよしです!笑

Tác giả : Kiyoshi (Chis Thanh)

Kiyoshi là một cựu du học sinh tại Nhật Bản. Sau khi tốt nghiệp đại học Toyama năm 2017, Kiyoshi hiện đang làm BrSE tại Tokyo, Nhật Bản.