2010-03-27 32 views
35

Tôi biết rằng bạn có thể nhấn shift + alt + j để chèn một mẫu nhận xét thích hợp cho khối mã hiện tại, nhưng có cách nào để nhật thực chỉ phát điên và thực hiện toàn bộ dự án như thế này không?Bất kỳ cách nào để tự động tạo TẤT CẢ các nhận xét Javadoc trong Eclipse?

+0

Erm, bất kỳ lý do hợp lệ nào để thực sự làm như vậy? Tôi biết những người nghĩ rằng tài liệu được tạo tự động tốt hơn không, nhưng chúng thực sự không chứa nhiều thông tin hơn ... nó chỉ làm cho việc tìm kiếm các địa điểm cần tài liệu khó hơn ... – Joey

+11

Có một lý do hợp lệ để làm cái này. Nó sẽ tiết kiệm cho tôi phải tự nhấn phím shift + alt + j hàng trăm lần khi tôi đi qua tất cả các mã của tôi viết javadoc. – Finbarr

+0

Tôi hy vọng bạn muốn biết không bao giờ sử dụng nó một cách vô tình,) – eckes

Trả lời

53

Đối với một dự án toàn, có thể là không, nhưng bạn có thể ít nhất là:

  • đi đến Package Explorer Xem
  • mở rộng lớp học mà bạn muốn tạo ra bình luận về (mở từng phương pháp)
  • chọn tất cả các yếu tố mở trong lớp từ đó Package Explorer Tree
  • alt + thay đổi + J và thì đấy: bình luận tạo ra trên lớp, và mỗi phương pháp

Lý do duy nhất nó không phải là thực tế cho tất cả các dự án là:

  • bạn cần phải mở tất cả các lớp học mà bạn muốn tạo ra nhận xét về
  • khi một bộ phương pháp đầu tiên đã được nhận xét, bạn vẫn cần phải lặp lại quy trình nếu bạn đã viết phương pháp mới.

đó đang được nói, cách tiếp cận khác được mô tả trong bài viết "The Problem of Incomplete Javadocs" từ tháng ba, ngày 30 tháng năm 2010, ủng hộ cho một extended Javadoc view.

Chế độ xem Javadoc mở rộng về cơ bản là tập hợp các nguồn thông tin khác nhau cho một phần tử mã đơn lẻ như lớp, phương pháp, trường hoặc tham số. Nó được thiết kế như là một sự thay thế cho Eclipse Javadoc hiện có.

alt text

Phần thú vị đi kèm với các tab khác trong giao diện: Chỉ thị subclassing và Patterns subclassing.
Các tab này chứa thông tin được khai thác về cách các nhà phát triển thường mở rộng phần tử mã đã chọn. tab

  • subclassing:

chỉ subclassing được khái quát các quan sát thường xuyên thực hiện trong mã ví dụ như "lớp con của Wizard luôn ghi đè phương pháp của nó addPages()" hoặc "Reimplementors của Dialog.createContents() có thể gọi siêu của nó thực hiện".

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard.png

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-directives-Wizard-addPages.png

  • Patterns subclassing Tab

mẫu subclassing cố gắng nhóm quan sát các phần mở rộng của một lớp cơ sở vào mô hình mở rộng điển hình, tức là, họ cụm lớp con tương tự như tìm mẫu trong dữ liệu.

http://code-recommenders.googlecode.com/svn/wiki/images/extdoc/tab-subclassing-patterns-ViewerComparator.png

+0

Bạn có thể vui lòng trỏ tới mục menu cho phím tắt Alt + Shift + J cho chúng tôi người Mac? –

+0

@Nithesh: Cmd-Shift-J trên máy Mac như được đề cập trong http://mobile.tutsplus.com/tutorials/android/javadoc/ – VonC

+0

Lưu ý đến bản thân: huy hiệu "câu trả lời hay" và "Giác ngộ" đi kèm với thứ 10 đó bỏ phiếu đánh dấu biểu tượng thứ 1000 của tôi trên SO, ngày 24 tháng 8 năm 2012. – VonC

6

Ngoài ra còn có plugin này, mà tôi chưa thử, nhưng trông đầy hứa hẹn: JAutoDoc

19

Tôi cũng đang tìm kiếm một công cụ tự động javadoc cho Eclipse và tìm thấy một gọi JAutodoc.

Công cụ này tạo nhận xét khá tốt và chỉ yêu cầu thay đổi nhỏ theo cách thủ công ở một số nơi (nếu bạn yêu cầu). Theo tôi, công cụ này có thể tiết kiệm khoảng 75% thời gian dành cho việc viết bình luận.

Bạn có thể truy cập here để được hướng dẫn chi tiết về cách tải xuống và tích hợp với nhật thực.

+1

Cảm ơn @Arun. Tôi có các chú thích được cấu hình trong Eclipse, nhưng Alt + Shift + J đặt một javadoc rỗng thay vì sử dụng một tệp được định cấu hình (Preferences> Java> Kiểu Mã> Mẫu Mã). JAutodoc đã làm những gì tôi muốn. Bây giờ tôi có JAutodoc trên danh sách yêu cầu :) –

+0

JAuto Doc tạo ra các bình luận tốt hơn nhật thực Alt + Shift + J – Sabyasachi

Các vấn đề liên quan