Nếu bạn là một kỹ sư phần mềm làm việc trong những dự án lớn của Mỹ, Nhật... thì chắc chắn bạn sẽ phải tuân theo những tiêu chuẩn rất nghiêm ngặt trong việc kiểm soát chất lượng phần mềm và các tiêu chuẩn về định dạng mã nguồn (code) cũng là một trong số đó. Thông thường, yêu cầu từ phía khách hàng hoặc QA sẽ buộc bạn phải có comment ở đầu tất cả các method, khai báo biến, hằng số, class... chưa kể tới những comment cụ thể về logic hoặc business. Đối với những file mã nguồn lớn vài ngàn dòng thì công việc này thật sự không hề dễ chịu chút nào.
Do đó, hôm nay tôi sẽ giới thiệu tới các bạn công cụ JAutoDoc giúp giảm thiểu effort bỏ ra cho việc tạo các comment ở đầu class, method, variable... Có thể bạn sẽ tự hỏi comment tự sinh ra có ý nghĩa gì không? Tại sao phải cần có nó? Câu trả lời là comment sẽ được sinh ra dựa vào tên lớp, tên biến, hằng số của bạn, do đó bạn nên đặt tên mọi thứ sao cho có ý nghĩa một chút. Việc có các comment tự động sẽ giúp bạn vượt qua các tiêu chuẩn kiểm soát từ các công cụ khác như Check Style, PMD... Vậy nên JAutoDoc thực sự là cứu tinh của các nhà phát triển.
JAutoDoc có hỗ trợ run từ Ant nên khá tiện dụng nếu bạn muốn sinh comment tự động từ file build.xml.
Các bạn có thể download JAutoDoc từ trang chủ của nó:
Hoặc vào Eclipse chọn Help > Eclipse Marketplace search theo từ khóa "jautodoc" sau đó bấm "Install" để tải về và cài đặt.
CÁCH SỬ DỤNG:
Để dùng JAutoDoc rất đơn giản, các bạn chỉ cần mở một file bất kỳ muốn sinh comment, nhấn Ctrl + A để bôi đen toàn bộ mã nguồn sau đó nhấn chuột phải chọn JAutoDoc > Add Javadoc như hình hoặc nhấn tổ hợp phím Ctrl + Alt + J.
Giả sử class ban đầu của bạn như sau:
Sau khi được sinh comment nó sẽ như thế này: khá đầy đủ phải không?
Để cấu hình và tùy biến comment, cũng làm như trên nhưng chọn tùy chọn bên dưới hoặc nhấn tổ hợp phím Ctrl + Alt + I:
Ở đây các bạn có thể tùy biến rất nhiều thứ cho comment của mình, đặc biệt là phần File Header sẽ giúp bạn sinh header comment theo template rất tiện lợi:
Cấu hình File Header như sau rồi chọn Edit:
Ở đây tôi có một header template như sau:
Header này sẽ giúp tự động sinh ra comment ở đầu file như thế này: rất tiện lợi phải không nào?
Trên đây là những hướng dẫn cơ bản nhất trong việc sử dụng JAutoDoc. Để đọc hiểu thêm các tính năng khác, các bạn vui lòng xem trực tiếp trên trang chủ của JAutoDoc.
Loading...