2011-09-11 38 views
17

Có dễ dàng thêm một khối chú thích (kiểu Javadoc) vào mọi phương thức trong một dự án Eclipse và có thể các lớp để tôi có thể điền vào chúng sau này không?Làm thế nào để thêm khối bình luận vào các phương thức trong Eclipse?

+3

Có, bạn có thể nhấp chuột phải vào phương thức khai báo, sau đó nhấp vào 'Nguồn> Tạo yếu tố nhận xét'. Tuy nhiên, nó không phải là một ý tưởng tốt để thêm tài liệu sau này ... điều này không bao giờ hoạt động. Tài liệu mỗi phương pháp trước khi bạn thực hiện nó hoặc ít nhất ngay lập tức sau khi thực hiện nó! – home

+0

Tôi nhận ra rằng, nhưng tốt hơn mà không bao giờ :) –

Trả lời

29

Như được đề xuất, bạn có thể thực hiện phương pháp trên mỗi phương thức (Nguồn -> Tạo nhận xét phần tử) hoặc ALT+SHIFT+J nhưng tôi thấy đó là một ý tưởng rất tồi. Nhận xét chỉ hữu ích khi họ cung cấp thêm thông tin. Khi bạn cảm thấy cần thêm thông tin, hãy thêm nó.

Có nhận xét về người định cư như "đặt giá trị" hoặc nhận xét được tạo tự động tồi tệ hơn không hữu ích chút nào.

+4

+1; tự động tạo tài liệu cho * mọi thứ * là phản tác dụng cuối cùng do tiếng ồn quá mức. –

+1

Phương thức này thêm khối bình luận vào biến và phương thức của lớp. Tuy nhiên nó chỉ thêm một bình thường/* */trên đầu trang của mỗi phương pháp mà không có chi tiết khác. Tôi nhớ sử dụng chương trình để thêm nhận xét kiểu PHPdoc vào mọi chức năng trong các dự án PHP với nhiều chi tiết. Dù sao, cảm ơn cho câu trả lời. –

+0

"đặt giá trị" loại nhận xét thực sự làm trầm trọng khả năng đọc mã. –

7

Dưới

Window | Tùy chọn | Java | Kiểu mã | Mã Templates

bạn sẽ tìm thấy 2 tính năng:

  • Tự động thêm ý kiến ​​cho các phương pháp mới hoặc các loại
  • Bình luận | Phương pháp | Chỉnh sửa ...

Bạn có thể chỉnh sửa khối nhận xét đã tạo bằng cách sử dụng các biến nhật thực hoặc văn bản Javadoc tĩnh của bạn.

+0

Trong đó tôi có thể áp dụng nhận xét phương thức vào mã nguồn? Ví dụ trong (Nguồn -> Tạo bình luận phần tử), chúng ta có thể tạo ra để nói bình luận lớp, có cách nào nhanh chóng mà chúng ta có thể có "Tạo bình luận phương thức" không. – user454083

5

Để thêm nhận xét trên phương pháp chọn getUser hoặc đưa con trỏ trước getUser và nhấn ALT + SHIFT + J Nó sẽ thêm nhận xét ở trên cùng phương thức của bạn

/* 
* @param 
* @return User 
*/ 
public User getUser(); 
+0

Điều này sẽ thêm bình luận của lớp, phải không? – hirosht

+0

@hirosht có, nó là – David

0

sử dụng các bước sau đây một cách dễ dàng. trong nhật thực đi đến dự án -> tạo javadoc -> nhấn enter và sau đó chọn dự án của bạn để được ghi lại.

0

Người dùng Mac: ^ - - J

  • Lựa chọn - ⌥
  • Control -^

của Windows Users: phím Shift - Alt - J

PS: Hãy chắc chắn rằng bạn có JAutodoc Plugin cài đặt

2

điều đơn giản là, bạn chỉ cần gõ/** và nhấn Enter trên đỉnh của phương pháp, nơi bạn muốn tạo ra bình luận .it tự động tạo ra các phần tử Không cần phải đi cho Key dài.

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