Модуль PODs

2015-11-03 13:15:17 / author: sharkov views 962Total views: 962 / 6Views for 7 days: 6
Thanks to Best cliparts
source article: http://world.std.com/~swmcd/steven/perl/module_pod.html

Дакументацыя для модулі Perl напісана простай мовай разметкі называецца POD (Plain Old Documentation). У гэтым раздзеле паказана, як напісаць модуль для Perl модуль. Калі прытрымлівацца гэтага стылю, то гэта будзе прасцей для іншых, каб чытаць і разумець дакументацыю. h2xs ўплывае на шкілет струк у канцы .pm файл, што ен піша. Чытанне модуляў ў існуючыя модулі для дадатковых прыкладаў.

=head1 NAME

Geometry::Circle - manages a circle
Назва раздзела змяшчае імя модуля і апісанне ў адну радок.

Назва і апісанне падзяляюцца працяжнік. Важна прытрымлівацца гэтага фармату, так што струк можа быць канвертаваны ў нармальнага мужчыну старонкі.

=head1 SYNOPSIS

  use Geometry::Circle

  $circle  = new Geometry::Circle $x, $y, $r

  ($x, $y) = $circle->center;
  $radius  = $circle->radius;
  $area    = $circle->area

  $pi      = $Geometry::Circle::PI;
Сінопсіс раздзеле паказаны асноўныя крокі ў выкарыстанні модуль: выкарыстанне заявай, любых падпраграм, зменных або метадаў класа, і ўсе метады аб'екта. Выклікі метаду варта паказаць іх параметры і вяртаюцца значэння.

Водступ кожнай радкі ў рэзюмэ. Гэта робіць яго даслоўна пункт, і гарантуе, што ваш расклад захаваецца.

=head1 REQUIRES

Perl5.8.8, Exporter, Geometry::Point
Раздзел "requires" кажа карыстачу, што яны спатрэбяцца для таго, каб выкарыстоўваць гэты модуль.
=head1 EXPORTS

Nothing
Раздзеле exports паведамляе Карыстачу, што модуль будзе рабіць іх іменаў, калі яны выкарыстоўваюць яго.
=head1 DESCRIPTION

Geometry::Circle manages circles.  
Methods are provided for creating 
circles and computing their areas.
Гэта апісанне модуля.

Яна павінна быць напісана ў тэрмінах, якія маюць дачыненне да карыстача, а не праграмісту.

  • Што яна робіць для карыстальніка?
  • Як вы ім карыстаецеся?
  • Якія аб'екты ен падтрымлівае?
  • Якія метады ен дае?
=head1 METHODS

=head2 Creation

=over 4

=item new Geometry::Circle $x, $y, $radius

Creates and returns a 
new Geometry::Circle object 
with center ($x, $y) and radius $radius.

=back

=head2 Access

=over 4

=item $circle->center

Returns a list of the x,y coordinates 
of the center of the circle.

In scalar context, 
returns an array reference.

=item $circle->radius

Returns the radius of the circle.

=item $circle->area

Returns the area of the circle.

=back
Метады раздзел змяшчае спіс і апісанне кожнага метаду ў класе.

У далейшым Вы можаце арганізаваць метады пад узровень-2 рубрык, такія як стварэнне, доступ і карыснасці.

=head1 CLASS VARIABLES

=over 4

=item $Geometry::Circle::PI

The ratio of the circumference 
of a circle to its diameter.

=back
Клас зменных раздзеле пералічаны ўсе зменныя пакета ў API.
=head1 DIAGNOSTICS

=over 4

=item Negative radius

(F) A circle may not be created with a negative radius.

=back
Раздзел дыягностыкі дае тэкст у кожным паведамленні пра памылку на модуль можа генераваць, і тлумачыць яе сэнс.

Паведамленні аб памылках класіфікуюцца наступным чынам:

(W)
Папярэджанне (апцыянальна)
(D)
Звязаная з састарэння (апцыянальна)
(S)
Сур'езнае папярэджанне (абавязковае)
(F)
Фатальная памылка (перахапляць)
(X)
Вельмі неадхільная памылка (не перехватываемая)
=head1 AUTHOR

A. U. Thor, a.u.thor@a.galaxy.far.far.away
Вы павінны пазначыць Ваша імя і адрас электроннай пошты, у выпадку, калі хто павінен звязацца з Вамі з нагоды модуля.
=head1 SEE ALSO

perl(1), Geometry::Square
Гэта звычайны пералік спадарожных праграм і модуляў.
=cut
У =cut надрэзу пазначае канец струка тэксту.

Некаторыя людзі распаўсюджваюць струк секцый па ўсей іх зыходны код. На Perl прызнае струк раздзелы і ігнаруе іх.

paper4pc
Add a comment:
Sign in

See also

Behaviourism

Бігейвіярызму

2015-11-11 11:58:42

Паводніцкія (або "паводніцкай" тэорыі ў псіхалогіі-гэта вельмі істотны поля: па спасылках злева ці справа для ўвядзення да некаторых з яе...

Юрких

Spritely

2015-11-10 19:23:32

Spritely ўяўляе сабой просты убудова з толькі два ключавых метадаў, спрайт() і пан() якія проста аніміраваць фонавы малюнак ўласцівасці CSS...

logical fallacy

Што такое лагічная памылка?

2015-11-10 19:03:45

А "памылка" - гэта памылка, і "лагічны" зман-памылка ў развагах. Есць, вядома, іншыя віды памылкай, чым памылкі ў развагах. Напрыклад,...

Вэб-дызайн: з дапамогай WS_FTP

Вэб-дызайн: з дапамогай WS_FTP

2015-11-11 11:48:14

З дапамогай WS_FTP Працэс перадачы файлаў з аднаго месца ў іншае, напрыклад для вашага прасторы на вэб-серверы называецца FTP (пратакол перадачы...

Art for designers dkcoin8.com (DesignerKit)