2011-10-09 4 views
5

Tôi vừa mới bắt đầu sử dụng IntelliJ IDEA cho lập trình Java và tôi thấy thẻ (được gọi là thẻ?) Như @param và @return. Ý nghĩa của các thẻ này là gì? IntelliJ thực sự phàn nàn nếu tôi không có các thẻ đó trong mã của tôi!Các thẻ như @param và @return trong IntelliJ IDEA là gì?

Những điều quan trọng nhất cần biết và chúng được sử dụng để làm gì?

Tôi không thể tìm thấy bất kỳ nội dung nào có liên quan trong tài liệu IntelliJ về các thẻ này.

+0

trong mã hoặc trong nhận xét? – stivlo

+0

Trong các ý kiến ​​trong mã, heh. – InvalidBrainException

+2

Các thẻ bắt buộc và mức cảnh báo là kiểm tra có thể định cấu hình - chỉ cần tìm kiếm "javadoc" trong cài đặt. –

Trả lời

7

Có, chúng được gọi là thẻ. Nếu bạn thấy các thẻ đó trong các nhận xét, chúng sẽ ghi lại các tham số và giá trị trả về của phương thức của bạn.

Chúng có thể được xử lý tự động để tạo tài liệu JavaDoc. Tài liệu được tạo sẽ tương tự như Java API Documentation. Xem how to write doc comments for the JavaDoc tool.

+0

Cảm ơn. Bằng cách áp dụng khỉ-nhìn khỉ-do, tôi thu thập rằng định dạng chung cho một thẻ là @tag variable_name_if_any mô tả. – InvalidBrainException

+1

Không phải tab, chỉ cần khoảng trắng. Ngoài ra, chỉ để làm cho nó rõ ràng, các thẻ này không cụ thể cho IntelliJ. –

+0

Những thẻ này có vô dụng trong mã được tạo bên ngoài một IDE không? Tức là, mã được tạo bằng trình soạn thảo văn bản và được biên dịch trên dòng lệnh? – InvalidBrainException