Mục lục
Comment thường được dùng để gợi nhớ, lưu ý hoặc mô tả một đoạn code trong mã nguồn Java của chúng ta. Tuy nhiên cũng có một số ý kiến cho rằng việc comment một cách vô tội vạ, ở đâu cũng comment là không cần thiết, trong một số trường số trường hợp nó còn làm cho mã nguồn trở nên tồi tệ hơn.
Trong bài viết này, chúng ta sẽ cùng nhau tìm hiểu cách comment trong Java, và một số lưu ý để comment sao cho đúng và có ý nghĩa.
Comment là gì?
Trong lập trình máy tính, comment là một phần của chương trình sẽ bị trình biên dịch Java bỏ qua. Chúng chủ yếu được sử dụng để giúp các lập trình viên hiểu mã. Ví dụ,
// khai báo 2 biến a và b
int a =1;
int b = 3;
// xuất ra kết quả
System.out.println("This is output");
Các kiểu comment trong Java
Trong Java, chúng ta có 2 cách comment:
- Comment trên một dòng
- comment trên nhiều dòng
Comment trên một dòng
Comment trên một dòng có nghĩa là nội dung comment bắt đầu và kết thúc trên cùng một dòng. Để viết comment trên một dòng, chúng ta sẽ sử dụng 2 ký tự //.
// "Hello, World!"
class Main {
public static void main(String[] args) {
{
// xuất ra màn hình "Hello, World!"
System.out.println("Hello, World!");
}
}
Output:
Hello, World!
Ở chương trình trên, chúng ta có 2 comment trên cùng một dòng:
- “Hello, World!”
- // xuất ra màn hình “Hello, World!”
Trình biên dịch Java bỏ qua mọi thứ đằng sau cặp dấu //.
Comment trên nhiều dòng
Khi chúng ta muốn comment trên nhiều dòng, thì chúng ta có thể sử dụng cặp dấu /*….*/. Các comment sẽ được đặt bên trong chúng.
/*
Đây là một ví dụ comment nhiều dòng
* Chương trình sẽ in ra "Hello, World!" trên màn hình console.
*/
class HelloWorld {
public static void main(String[] args) {
{
System.out.println("Hello, World!");
}
}
Output:
Hello, World
Chúng ta có đoạn comment trên nhiều dòng
/* Đây là một ví dụ comment nhiều dòng * Chương trình sẽ in ra "Hello, World!" trên màn hình console. */
Trình biên dịch sẽ bỏ qua mọi thứ được đặt bên trong cặp dấu /*….*/.
Comment sao cho đúng cách
Comment được dùng để giải thích ý nghĩa của mã code mà chúng ta viết ra, tuy nhiên đừng lạm dụng nó để giải thích cho một mã nguồn có cấu trúc kém chất lượng. Bạn nên tổ chức cấu trúc dự án tốt, và một phần nào đó nó đã giải thích một phần code cho các bạn, sau đó hãy sử dụng comment.
Một số người còn cho rằng, mã nguồn nên từ mô tả tính năng của nó, ví dụ như họ viết hàm
findByEmail
nhìn vào thì chúng ta đã hiểu hàm này dùng để tìm kiếm theo email, không cần phải viết thêm comment làm gì. Tuy nhiên, chúng ta có thể sử dụng comment dể mô tả các thuật toán phức tạp, các chuỗi regex, hoặc một số mã nguồn triển khai business được mô tả trong file docs mà khiến người khác rất khó hiểu.
Lưu ý: Trong hầu hết các trường hợp, hãy luôn sử dụng comment để giải thích ‘why‘ thay vì ‘how’.
Nguồn