Liệu Perl có một cái gì đó giống như Java/PHP Docs?

Question

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?

Answer 1

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.

Answer 2

Bạn có nghĩa là perldoc?

Cũng thấy điều này liên quan Stack Overflow quesion:

• What’s the best way to document Perl code?

Answer 3

Tại sao, vâng. Có, nó! Perldoc.

Answer 4

[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ờ.