Perl có trình tạo tài liệu Perl không? Một cái gì đó như Java Docs hoặc Documenter PHP?Liệu Perl có một cái gì đó giống như Java/PHP Docs?
Trả lời
Vâng, nó được gọi là perldoc
Bạn chỉ cần viết tài liệu trong nguồn, giống như với javadoc.
Tóm tắt, "= mục" là một mục có dấu đầu dòng, ví dụ: một hàm hoặc tham số "= over" giảm xuống một mức độ nhận dạng, "= trở lại" tăng lên một mức. Sử dụng "= cut" nơi bạn muốn chuyển về mã perl.
Dưới đây là một ví dụ về những gì nó có thể trông giống như:
=item $b->add_module (%options)
Initialize a module. A module is a repository or a branch of a repository.
Valid options are
=over
=item id
Id of this module
=item repo
Url of repository. Currently only subversion repositories are supported.
=back
=cut
sub add_module($%)
{
Đơn giản chỉ cần vượt qua mã perl của bạn thông qua các chương trình perldoc để có được những tài liệu định dạng.
Vâng, nó hoàn toàn khác với JavaDoc hoặc PHPDoc liên quan đến cách bạn viết tài liệu, nhưng afaik nó là công cụ tài liệu chuẩn – Gordon
Tôi sẽ cao đề nghị không bao giờ sử dụng pod giữa mã (interlaced), như đánh dấu là thực sự cồng kềnh và sẽ chỉ phục vụ để làm xáo trộn điều hướng và mã mạch lạc. Viết mã tự tạo tài liệu và đặt nhóm ở cuối tài liệu bên dưới thẻ '__END__'. –
trả lời Evan Carroll - đây chỉ là sở thích cá nhân - tôi thường thích pod xen kẽ, giúp dễ dàng cập nhật tài liệu hơn và mọi trình chỉnh sửa phong phú sẽ giúp bạn dễ dàng xem mã và phần nào là gì. – plusplus
Bạn có nghĩa là perldoc?
Cũng thấy điều này liên quan Stack Overflow quesion:
Tại sao, vâng. Có, nó! Perldoc.
[chỉ dành cho googlers] Như mọi người đã nói, bạn tạo tài liệu với POD (không phải nhận xét, nhận xét dành cho người bảo trì, nhóm dành cho tài liệu người dùng). Thông thường, bạn thêm POD vào đầu và cuối tập lệnh hoặc mô-đun và trước mỗi phương thức, sau đó bạn có thể sử dụng perldoc your_module
trong bảng điều khiển hoặc pod2html
để chuyển đổi sang html và duyệt trong máy chủ hoặc sử dụng pdoc (đó là bit cũ nhưng rất hữu ích khi bạn muốn có một web navigator và liên kết đến các mã trong web).
có một câu hỏi mới hơn về định dạng pod đó có thể cũng quan tâm của bạn perl-documentation-pod-browsers
và điều này một how-can-i-generate-html-documentation-for-perl-code-comments
Và có một số khác nói về để làm một pod2html và sử dụng một tập tin css để bắt chước các trang cpansearch, nhưng tôi không thể tìm thấy nó ngay bây giờ.
- 1. Có cái gì đó giống như `last` cho` map`?
- 2. Có cái gì đó giống như WMI cho Linux?
- 3. Do regexes Python hỗ trợ một cái gì đó giống như của Perl \ G?
- 4. Có cái gì đó giống như Python 'với' trong C#?
- 5. Có cái gì đó giống như Incanter cho Haskell?
- 6. MATLAB Có một cái gì đó giống như danh sách hiểu như nó là trong python?
- 7. Ruby có một cái gì đó giống như sự hiểu biết danh sách của Python?
- 8. Có một cái gì đó giống như Sprocket tồn tại cho Java
- 9. Gson có một cái gì đó giống như @JsonProperty cho phương pháp?
- 10. Scala/java có một cái gì đó giống như StringIO từ python?
- 11. là gì lệnh p4 tương đương với một cái gì đó giống như tình trạng svn
- 12. Liệu python có một cái gì đó giống như C++ 's bằng cách sử dụng từ khóa?
- 13. Một cái gì đó giống như một chức năng/phương pháp trong các tập tin batch?
- 14. Vim cho Word (hoặc một cái gì đó giống như nó)
- 15. Tìm kiếm một cái gì đó giống như của JUnit @Before/@After trong MUnit
- 16. Có điều gì đó giống như "Di tích mới" cho ứng dụng Perl không?
- 17. là có cái gì đó giống như isset của php trong javascript/jQuery?
- 18. Python: Một cái gì đó giống như `bản đồ` hoạt động trên các chủ đề
- 19. C++ literals vector, hoặc một cái gì đó giống như họ
- 20. ReSharper (hoặc một cái gì đó giống như nó) cho Qt?
- 21. Một cái gì đó giống như chức năng đại biểu gọi lại trong php
- 22. Có cái gì đó giống như máy phát điện Python trong Ruby?
- 23. Có cái gì đó giống như IIS 6.0 Resource Kit Tools cho IIS 7?
- 24. Có cái gì đó giống như strall Linux ptrace trong Windows?
- 25. Bất cứ ai cũng biết một cái gì đó giống như RSPec cho PHP?
- 26. Có điều gì đó giống như find_if trong Java không?
- 27. Một cái gì đó như Tryparse từ Convert.FromBase64String
- 28. Cái gì đó tương tự như split()?
- 29. Một cái gì đó như tăng :: multi_index cho Python
- 30. Có sử dụng một cái gì đó giống như MvcContrib Grid một bước lùi trong khả năng đọc mã?
POD? Chuyển đổi sang hoặc từ POD? Mọi người viết sách trong POD! Tìm CPAN cho POD! POD người! – Anonymous
Đây là trang wikipedia trên POD: http://en.wikipedia.org/wiki/Plain_Old_Documentation – draegtun