Aenigma / Aenigma/ActionMockup

Javadoc Should Not Containing Implementation Details

Đang mở
#11 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement help wanted
Ngôn ngữ chính
Java
Star
0
Fork
0
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Comments are great. Javadocs are comments but not necessarily all comments are javadoc worthy.

Do not do things like make excuses for implementations and such for all public members. Perhaps move "personal" comments into non-javadoc comment blocks within the method block.

This task isn't high priority right now, though; just something that should be done between now and the final product. Over time, we should be listing out these kinds of comments and listing it here.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.