Phương thức nhận xét nào được chấp nhận rộng rãi nhất hay nó thực sự quan trọng?Các quy ước chú thích Java
tôi đã được sử dụng
/**
* (Method description)
* @param
* @return
* etc
*/
Tuy nhiên tôi đã đọc của:
Precondition:
Postcondition:
Có cách nào hơn 'chuyên nghiệp' của cho ý kiến?
Sau đây là các Java mã hóa quy ước để lấy ý kiến khuyến cáo của Oracle:
Dưới đây là khuyến nghị của Google cho nền tảng Android của họ:
Để biết thông tin chi tiết hơn về phong cách và công ước cho Javadoc, xem tại đây:
Các liên kết đến các khuyến nghị của Google dường như đã biến mất hoặc bị hạn chế. Có lẽ đây là sự thay thế? http://source.android.com/source/code-style.html#use-javadoc-standard-comments –
Tôi nghĩ rằng các quy ước Javadoc là tốt nhất. Có ai có pdf khuyến nghị Oracle hoặc địa chỉ mới? –
Các bình luận phong cách trong ví dụ đầu tiên của bạn không chỉ là một quy ước, nó là một tiêu chuẩn cho một công cụ tài liệu được gọi là Javadoc. Nếu bạn làm theo kiểu nhận xét Javadoc đó, bạn sẽ có thể dễ dàng tạo tài liệu định dạng html cho tất cả mã nguồn của bạn.
Tôi chỉ cần làm theo tiêu chuẩn do Sun (Oracle) xác định để viết Javadoc. Javadoc được tất cả các nhà phát triển giới thiệu một cách nhất trí :). Để biết thêm thông tin, hãy nhấp vào here
Tôi cũng sẽ yêu cầu bạn làm theo số search on Stackoverflow cho nhiều câu hỏi và ansers về nhận xét.
This liên kết là rất hữu ích và tôi đã được sử dụng trong một thời gian dài và đã giúp tôi rất nhiều. Điều này tạo ra một mã rất tốt và tài liệu với readiblity tối đa.
Trước tiên, tất cả đều có mã có thể đọc và nhận xét có thể đọc được là hai điều hoàn toàn khác nhau.
mã dễ đọc là mã sử dụng biến tốt, phương pháp, tên lớp, vv
comments Readable nhiều là vấn đề sở thích cá nhân. Một số người thích nhận xét tuân theo các quy tắc ngữ pháp sẽ được sử dụng để viết một cuốn sách trong khi những người khác không quan tâm nhiều về các công cụ ngữ pháp. Bạn có thể đi qua liên kết này:
http://www.oracle.com/technetwork/java/codeconventions-141999.html#385
Từ mã dễ đọc và bình luận, bạn có thể tạo tài liệu với sự giúp đỡ của doxygen.
thể trùng lặp của [Bình luận ước] (http://stackoverflow.com/questions/999431/commenting-conventions) – krock