- vừa được xem lúc

Làm chủ Javadoc: Cách ghi chép tài liệu cho mã Java của bạn

0 0 1

Người đăng: Vinh Phạm

Theo Viblo Asia

Để nâng cao khả năng đọc và sử dụng mã, việc viết các comment JavaDoc rõ ràng, súc tích là một nỗ lực nhỏ nhưng mang lại hiệu quả lâu dài. Cho dù bạn đang thực hiện dự án cá nhân hay làm việc nhóm, việc sử dụng JavaDoc đảm bảo mã của bạn được ghi chép đầy đủ và dễ hiểu.

Khác với comment thông thường, comment JavaDoc được cấu trúc để tự động tạo tài liệu HTML thân thiện với người dùng cho các lớp, phương thức và trường trong mã của bạn. Điều này đặc biệt hữu ích khi làm việc trong nhóm hoặc tạo API mà người khác cần hiểu cách sử dụng mã của bạn.

Để viết JavaDoc, bạn sử dụng các khối comment đặc biệt bắt đầu bằng /** và kết thúc bằng */. Ví dụ:

package basics; /** * This class demonstrates how to create JavaDoc for a simple Java class. * * @author Arshi Saxena */
public class CreateJavaDoc { /** * This method performs a simple addition of three numbers. * * @param a -> the first number * @param b -> the second number * @param c -> the third number * @return -> the sum of a, b, and c */ public int add(int a, int b, int c) { return a + b + c; }
}

Trong ví dụ trên, khối comment phía trên lớp CreateJavaDoc cung cấp mô tả chung về lớp và sử dụng thẻ @author để thêm thông tin về tác giả. Khối comment phía trên phương thức add mô tả mục đích của phương thức và sử dụng các thẻ như @param@return để cung cấp chi tiết về tham số và giá trị trả về của phương thức.

Một số thẻ JavaDoc thường được sử dụng nhất bao gồm:

  • @author để chỉ định tác giả của lớp
  • @param để mô tả tham số trong phương thức
  • @return để mô tả kiểu trả về của phương thức
  • @throws hoặc @exception để mô tả ngoại lệ mà phương thức có thể ném ra
  • @deprecated để đánh dấu phương thức hoặc lớp đã lỗi thời
  • @see để tham khảo phương thức hoặc lớp khác để biết thêm thông tin.

Nếu bạn đang sử dụng IDE như Eclipse hoặc IntelliJ IDEA, các comment JavaDoc sẽ rất hữu ích. Bạn có thể di chuột qua các lớp và phương thức để xem mô tả JavaDoc trực tiếp trong trình chỉnh sửa.

Hy vọng mẹo hữu ích này sẽ giúp ích phần nào trong công việc của các bạn.

Bình luận

Bài viết tương tự

- vừa được xem lúc

Tổng hợp các bài hướng dẫn về Design Pattern - 23 mẫu cơ bản của GoF

Link bài viết gốc: https://gpcoder.com/4164-gioi-thieu-design-patterns/. Design Patterns là gì. Design Patterns không phải là ngôn ngữ cụ thể nào cả.

0 0 296

- vừa được xem lúc

Học Spring Boot bắt đầu từ đâu?

1. Giới thiệu Spring Boot. 1.1.

0 0 271

- vừa được xem lúc

Cần chuẩn bị gì để bắt đầu học Java

Cần chuẩn bị những gì để bắt đầu lập trình Java. 1.1. Cài JDK hay JRE.

0 0 49

- vừa được xem lúc

Sử dụng ModelMapper trong Spring Boot

Bài hôm nay sẽ là cách sử dụng thư viện ModelMapper để mapping qua lại giữa các object trong Spring nhé. Trang chủ của ModelMapper đây http://modelmapper.org/, đọc rất dễ hiểu dành cho các bạn muốn tìm hiểu sâu hơn. 1.

0 0 192

- vừa được xem lúc

[Java] 1 vài tip nhỏ khi sử dụng String hoặc Collection part 1

. Hello các bạn, hôm nay mình sẽ chia sẻ về mẹo check String null hay full space một cách tiện lợi. Mình sẽ sử dụng thư viện Lớp StringUtils download file jar để import vào thư viện tại (link).

0 0 69

- vừa được xem lúc

Deep Learning với Java - Tại sao không?

Muốn tìm hiểu về Machine Learning / Deep Learning nhưng với background là Java thì sẽ như thế nào và bắt đầu từ đâu? Để tìm được câu trả lời, hãy đọc bài viết này - có thể kỹ năng Java vốn có sẽ giúp bạn có những chuyến phiêu lưu thú vị. DJL là tên viết tắt của Deep Java Library - một thư viện mã ng

0 0 137