Câu hỏi được gắn thẻ «javadocs»

Gần đây tôi đã làm việc để tái cấu trúc các phần của cơ sở mã mà tôi hiện đang xử lý - không chỉ để hiểu rõ hơn về bản thân mà còn giúp những người khác đang làm việc với mã dễ dàng hơn. Tôi có xu hướng …

18 java  documentation  refactoring  javadocs 

Có một thuật ngữ tốt tương tự nhưng khác với "không dùng nữa" có nghĩa là một phương thức hoặc API nằm trong cơ sở mã nhưng không nên được sử dụng vì việc triển khai của nó không hoàn thành hoặc có thể sẽ thay đổi? (Vâng, tôi biết, …

12 documentation  terminology  api  documentation-generation  javadocs 

Trong JavaDoc cho X509Certificate getSubjectDN()nó nêu: Bị chê bai , thay thế bằng getSubjectX500Principal (). Tôi đã từng thấy Deprecated trong các phương thức không nên sử dụng nữa, nhưng không bị chê bai. Tôi đã tìm thấy một báo cáo lỗi về trường hợp cụ thể này khi nó …

11 java  terminology  javadocs 

Tôi đang làm việc trên một thư viện nhỏ cung cấp việc triển khai các số liệu chuỗi cơ bản, nổi tiếng. Chủ yếu là cho giáo dục của riêng tôi. Vì vậy, sự phát triển xảy ra bất cứ khi nào tôi có một chút thời gian rảnh rỗi. …

9 java  documentation  javadocs 

Tôi muốn viết Javadoc theo cách DRY. Nhưng tài liệu tiên tri về Javadoc nói viết lại điều tương tự trong bình luận phương thức quá tải. Tôi không thể tránh sự lặp lại?

9 documentation  comments  dry  javadocs 

Tôi chỉ bắt gặp những điều sau đây trong sổ tay phòng thí nghiệm tại trường đại học: Bạn cần nghiên cứu giao diện của các lớp bằng cách tạo javadoc cho chúng để bạn biết các hoạt động được cung cấp (hãy xem mã, nhưng khi sử dụng mã …

8 source-code  comments  javadocs 

Điều gì sẽ là một sự thay thế tốt cho tài liệu Java nội tuyến, tức là người ta có thể có một tệp tài liệu riêng bằng cách nào đó được ánh xạ tới tệp nguồn java không? Tôi chưa bao giờ thích phần bình luận lớn nằm rải …

8 java  documentation  javadocs