Lập trình Java cơ bản (Java core)

Khóa học lập trình Java cơ bản | Thời lượng 5 - 30 phút

Cách comment trong Java Cách comment trong Java Cách comment trong Java Cách comment trong Java Cách comment trong Java 5/5 (21 reviews)

Cách comment trong Java

Đã đăng 2016-11-07 20:03:36 bởi Kteam
10 bình luận 10024 lượt xem
Cách comment trong Java 5 /5 stars (6 reviews)
 

Dẫn nhập

Trong khi lập trình, nhiều khi có những đoạn code mà chúng ta viết rất lâu rồi nhưng 1 thời gian nào đó chúng ta phải sử dụng lại chúng. Lúc này, có rất nhiều bạn sẽ rơi vào trường hợp là không biết đoạn code đó lúc trước mình viết nó có tác dụng gì hay là trường hợp mình viết code xong rồi đưa cho người khác đọc để nâng cấp hoặc trong 1 nhóm làm việc cùng nhau thì vấn đề đặt ra là làm sao để người ta đọc và hiểu nó.

Vậy hôm nay mình sẽ hướng dẫn cho các bạn cách khắc phục đó là chúng ta sẽ để lại comment nhằm ghi chú lại giúp cho đoạn code của mình dễ hiểu và tường minh hơn.

Nội dung

Bài này sẽ giới thiệu bao gồm các nội dung sau:

  • Ghi chú trên một dòng.
  • Ghi chú trên nhiều dòng.
  • Ghi chú sử dụng Javadoc.

Ghi chú trên một dòng (Single line comment)

Cú pháp:

//<nôi dung cần ghi chú>

Ví dụ:

public static void main(String[] args)

            {

                                    String course = "Java"; //khởi tạo và truyền giá trị cho biến course

                                    String lecture = "Howkteam"; //khởi tạo và truyền giá trị cho biến lecture

                                    test t = new test();

                                   

                                    //Hàm Xuatthongtin dùng để in thông tin về khóa học

                                    t.Xuatthongtin(course, lecture);

                                   

            }

           

            public void Xuatthongtin(String course, String lecture)

            {

                        System.out.println("Course: "+course);

                        System.out.println("Lecture: "+lecture);

            }

 Trong đó:

 //Hàm Xuatthongtin dùng để in thông tin về khóa học

            t.Xuatthongtin(course, lecture);
  • Đây là dạng ghi chú trước các dòng code
String course = "Java"; //khởi tạo và truyền giá trị cho biến course
  • Còn đây là dạng ghi chú sau các dòng code

Ghi chú trên nhiều dòng (Multi line comment)

Cú pháp:

/*

<nội dung ghi chú dòng 1>

<nội dung ghi chú dòng 2>

…….

*/

Ví dụ:    

public static void main(String[] args)

            {                      

                        /*

                        Đề xuất thông tin ta cần 2 thuộc tính đó là course và lecture.

                        Do đó, ta khởi tạo 2 biến course và lecture rồi truyền giá trị vào cho 2 biến đó     

                        */

                                    String course = "Java";

                                    String lecture = "Howkteam";

                                   

                        /*

                        Sau khi khởi tạo giá trị, chúng ta khởi tạo hàm test đề có thể gọi hàm Xuatthongtin

                        sau đó chúng ta truyền 2 biến vừa khởi tạo là hoàn thành việc in thông tin

                        */

                                    test t = new test();

                                    t.Xuatthongtin(course, lecture);                                 

            }

           

            public void Xuatthongtin(String course, String lecture)

            {

                        System.out.println("Course: "+course);

                        System.out.println("Lecture: "+lecture);

            }

Ghi chú sử dụng Javadoc

Theo như cái tên trong tiêu đề thì quá rõ, chúng ta sẽ sử dụng 1 công cụ đó là Javadoc để hỗ trợ ghi chú

Cú pháp:

/**

             * <nội dung ghi chú>

             * @param args

*/

 Điểm khác biệt của cách ghi chú này là nó hỗ trợ chúng ta các Tags của Javadoc. Cụ thể là:

kteam

Khi các bạn gõ chữ @ trong phần viết ghi chú thì nó sẽ hiện ra 1 loạt các tag như hình trên. Các tag này sẽ giúp chúng ta giải thích 1 cách rõ ràng nhất về tham số, giá trị trả về … Sau đây mình sẽ đề cập cho các bạn công dụng của 1 số tag.

  • @author : chú thích tên tác giả của ứng dụng
  • @since : chú thích thời gian hoàn thành ứng dụng
  • @return :  chú thích nội dung  trả về của phương thức, … trong ứng dụng
  • @param : chú thích cụ thể về các tham số trong ứng dụng
  • @exception : chú thích về  các ngoại lệ sử dụng

Chúng ta sẽ đi vào ví dụ cụ thể:

/**
* AddNum là 1 ứng dụng cho phép người dùng cộng 2 số nguyên sau đó
* in kết quả ra màn hình
* @author  Howkteam
* @version 1.0
* @since   2014-10-30
*/

public class AddNum 
{
	   /**
	   * addNum là 1 phương thức dùng để cộng 2 số nguyên
	   * @param numA đây là tham số đầu tiên thể hiện số nguyên thứ nhất
	   * @param numB  đây là tham số thứ 2 thể hiện số nguyên thứ 2
	   * @return int phương thức addNum trả về kết quả là tổng 2 số với kiểu dữ liệu là số nguyên
	   */
	 
	   public int addNum(int numA, int numB) 
	   {
	      return numA + numB;
	   }
	   
	   /**
	   * Sau đây là hàm main để thực thi hàm cộng 2 số nguyên
	   * @param args không sử dụng.
	   * @return hàm main thì không trả về giá trị nào cả
	   */
	   
		public static void main(String[] args) 
		{
			  AddNum obj = new AddNum();
		      int sum = obj.addNum(10, 20);
	
		      System.out.println("Sum of 10 and 20 is :" + sum);
		}
}

Kết luận

Qua bài viết chúng ta đã biết cách ghi chú các đoạn code trong 1 ứng dụng sao cho tối ưu nhất, giúp cho bản thân người viết ra code hay là những người khác khi đọc sẽ hiểu rõ nội dung.

Bài sau chúng ta sẽ đi Tìm hiểu về biến và các kiểu dữ liệu trong Java

Cảm ơn các bạn đã theo dõi bài viết. Hãy để lại bình luận hoặc góp ý của mình để phát triển bài viết tốt hơn. Đừng quên “Luyện tập – Thử thách – Không ngại khó”.

Chia sẻ:
Thảo luận Hỏi và đáp Báo lỗi bài viết
Hủy bỏ   hoặc  
Cách comment trong Java
trthphong29 2018-03-12 21:59:34

Bài giảng rất hay, dễ hiểu. Rất mong sớm được xem bài tiếp theo.

0 bình chọn
Reply
Cách comment trong Java
Nhan Tam 2018-02-12 01:22:44

Sao ít thế ạ, admin ơi cập nhật thêm cho tụi em học với ạ!

0 bình chọn
Reply
View all 1 comments
Kteam - Howkteam Free Education
Kteam 2018-02-14 23:57:11
khóa này tạm thời không có CTV viết nhé bạn! Kteam sẽ cố cập nhập trong thời gian sớm nhất.
0 bình chọn
Reply
Cách comment trong Java
Q.A 2017-10-31 20:55:13

tại sao không tiếp tục series này vậy admin

 

0 bình chọn
Reply
Cách comment trong Java
xphantuananhx 2017-07-22 21:27:20

không thấy tiếp tục series này nhỉ :(

1 bình chọn
Reply
Cách comment trong Java
Z_Lazy 2017-06-04 04:50:52

Bài giảng hay lắm ad , ad tiếp tục ra tiếp phần kế đi. Em đang rất muốn học Java. <3

1 bình chọn
Reply
Cách comment trong Java
Z_Lazy 2017-06-04 04:50:48

Bài giảng hay lắm ad , ad tiếp tục ra tiếp phần kế đi. Em đang rất muốn học Java. <3

1 bình chọn
Reply
Cách comment trong Java
nguyễn văn cường 2017-02-15 21:07:55
add ơi bài giảng của anh hay lắm. Anh làm tiếp các bài tiếp không được không ạ. Chúc howkteam ngày càng phát triển!
1 bình chọn
Reply
Cách comment trong Java
Huy Tran 2017-02-07 21:24:13
Làm thêm bài tiếp đi anh ơi !! Luôn ủng hộ Kteam
0 bình chọn
Reply
View all 1 comments
Kteam - Howkteam Free Education
Kteam 2017-02-09 00:56:54
phần này đang tìm CTV viết tiếp nha e :)
0 bình chọn
Reply
Hủy bỏ   hoặc  
Hủy bỏ   hoặc  

Chiến dịch

Kteam - Howkteam Free Education