Tôi có thể tìm thấy một trang từ Safari Books Online cung cấp a template, nhưng chưa bao giờ viết nhận xét POD, tôi không chắc nó có hiệu quả như thế nào hay thiếu bất kỳ thứ gì có thể được coi là quy ước.Có bất kỳ quy ước nào để viết ý kiến POD cho Perl không?
Các quy ước cần tuân theo khi viết nhận xét POD cho tập lệnh Perl là gì? Có bất kỳ điều gì giống như Sun's Javadoc Conventions, nhưng đối với nhận xét POD?
Nó không phức tạp, nhưng tôi thích giới thiệu perlpodtut của Juerd rất nhiều.
Tác giả đề cập đến những gì anh ta xem xét các phần chung và những gì họ sẽ bao gồm.
Có một bộ đề xuất trong Perl Best Practices. Toàn bộ Chương 7 bao gồm tài liệu, sử dụng POD, và các phương pháp tốt nhất để tài liệu cho các mô-đun, các dự án lớn vv. Nó cũng nói về các quy ước của CPAN. Đó có lẽ là đặt cược tốt nhất của bạn.
Perl::Critic cung cấp các chính sách sau:
A list of required sections được cung cấp theo chính sách cuối cùng ở trên.
Module::Starter::PBP sẽ tạo mã bản mẫu cho bạn.
"Gợi ý viết Pod" không phải về nội dung. Tôi có lẽ nên chỉnh sửa câu hỏi của mình để rõ ràng hơn, nhưng tôi đặc biệt tìm kiếm nội dung và thiết kế (phân nhóm, tiêu đề, thụt đầu dòng ...) quy ước. Tôi nhìn vào RequirePodSections để sửa đổi các mẫu tôi nhìn vào để cố gắng cải thiện nó. –
Có, 1 cho phần yêu cầu mặc định một phần của tài liệu RequirePodSections. Tôi đang sử dụng điều đó để sửa đổi mẫu gốc mà tôi đã liên kết đến. Tôi nghĩ rằng tôi đã có một cái gì đó là phong nha, đó là tốt hơn so với những gì tôi bắt đầu với. –
Bạn có thể xem Pod cho mô-đun Perl trên CPAN Search và nhanh chóng lưu ý những điều mọi người làm. Các công cụ bắt đầu mô-đun khác nhau tạo ra bản mẫu cho bạn.
Điều đó gần đúng như bạn sẽ nhận được hướng dẫn.
Bạn có biết liệu bất kỳ điều này có sẵn trực tuyến miễn phí không? Tôi thích gợi ý về cuốn sách (đặc biệt là vì nó trông rất hoàn chỉnh và chuyên sâu), nhưng một cái gì đó tự do có sẵn để tôi bắt đầu sẽ là tốt nhất. –
@Thomas Owens: Tôi không nghĩ bất kỳ nội dung sách nào đều có sẵn trực tuyến miễn phí. Liên kết của Sinan với Perl :: Critic là một điều tốt. Một tùy chọn khác là xem tài liệu cho một số mô-đun CPAN cốt lõi. Mặc dù các phương pháp tiếp cận có thể thay đổi đôi chút, nhưng có các phần tiêu chuẩn, v.v. rất hữu ích như hướng dẫn. –