Nội dung
Giới thiệu
Nếu bạn đã từng làm việc với khách hàng Nhật hoặc sắp tới có tham gia vào dự án của khách hàng Nhật thì bạn chắc chắn sẽ phải tuân thủ những tiêu chuẩn rất nghiêm ngặt trong việc phát triển phần mềm của họ. Một trong những tiêu chuẩn đó là comment code. Thông thường, họ sẽ yêu cầu bạn comment ở đầu tất cả các class, method, khai báo biến, hằng số, comment về logic, … Đối với file vài trăm dòng thì công việc này sẽ nhàm chán và làm mất rất nhiều thời gian. Thật may mắn, Eclispe có một plugin rất mạnh mẽ hỗ trợ bạn công việc này, đó chính là JAutodoc.
JAutodoc là một Plugin Eclipse được sử dụng để tự động thêm Javadoc và file header vào mã nguồn của bạn. JAutodoc sẽ tự tạo comment dựa vào tên lớp, tên biến, … bằng cách sử dụng Velocity templates để tạo sinh comment.
Download và cài đặt plugin JAutodoc
Các bạn xem hướng dẫn ở bài viết Các plugin Eclipse thường dùng.
Hướng dẫn sử dụng
Để dùng JAutoDoc, bạn mở một file bất kỳ muốn sinh comment, chọn mã nguồn cần sinh comment -> nhấn chuột phải chọn JAutoDoc -> Add Javadoc hoặc nhấn tổ hợp phím Ctrl + Alt + J.
Ví dụ: Ban đầu file mã nguồn như sau:
Nhấn Chọn tất cả mã nguồn (hoặc nhấn Ctrl + A), sau đó nhấn chuột phải chọn JAutoDoc -> Add Javadoc (hoặc nhấn tổ hợp phím Ctrl + Alt + J). Ta được kết quả như sau:
Tùy chỉnh template sinh code của JAutodoc
Các bạn có thể tùy chỉnh comment code, bằng cách nhấn chuột phải lên mã nguồn cần sinh comment -> JAutodoc -> Add Javadoc… (hoặc nhấn phím Ctrl + Alt + I).
Tại cửa sổ Add Javadoc, 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 nhanh chóng.
Tại vùng File Header -> Edit …
Import: import template của header từ file text (.txt)
Export: export template ra file text (sử dụng khi muốn chia sẽ header cho các thành viên khác sử dụng).
Properties: cho phép bạn định nghĩa cặp tên/ giá trị sử dụng như biến trong header. Ví dụ: biến ${company} = gpcode.com
Kết quả sau khi nhấn chuột phải -> chọn Add JAutodoc -> Add Header…
Tùy chỉnh khác, các bạn có thể chỉnh lại template sinh comment cho getter và setter bằng cách: vào menu Window -> Preferences -> Java -> JAutodoc -> Template.
Trên đây là những hướng dẫn cơ bản nhất trong việc sử dụng JAutoDoc. Các bạn có thể tìm hiểu các tính năng khác trên trang document của JAutoDoc.
Hi vọng có thể giúp ích cho các bạn trong việc comment code trong dự án. Cám ơn các bạn đã quan tâm và theo dõi bài viết. Hẹn gặp các bạn ở các bài viết tiếp theo.