ORIGINAL SOURCE: http://world.std.com/~swmcd/steven/perl/module_pod.html

square meters to square feet

ПОД-модули

Документацијата за модулите во Перл е напишана на едноставен јазик за обележување наречен POD (обична стара документација).

Оваа страница покажува како да напишете POD за Perl модул. Ако се придржувате до овој стил, тогаш ќе им биде полесно на другите да ја читаат и разбираат вашата документација.

h2xs става скелет POD на крајот на датотеката .pm што ја пишува. Прочитајте ги ПОД во постојните модули за дополнителни примери. 

=head1 ИМЕ

Geometry::Circle - управува со круг
Делот NAME го дава името на модулот и едно-описот.

Името и описот се одделени со цртичка. Важно е да се придржувате до овој формат, така што ПОД може да се претвори во соодветна страница за човекот.		 
=head1 SYNOPSIS

  use користете геометрија :: Круг

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

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

  $pi      = $Geometry::Circle::PI;
Делот SYNOPSIS ги покажува основните чекори во користењето на модулот: изјава за употреба, какви било субрутини, класни методи или променливи и сите објективни методи. Методните повици треба да ги означат нивните параметри и вредностите за враќање.

Вметнете ја секоја линија во синопсата. Ова го прави зборот пред зборот и гарантира дека вашата траса ќе биде зачувана

. 

=head1 БАРАА

Perl5.8.8, Извозник, Геометрија :: Точка
Делот БАРАА му кажува на корисникот што ќе им треба за да го користи модулот. 
=head1 ИЗВОЗИ

Ништо
Делот EXPORTS му кажува на корисникот што ќе направи модулот до нивното име за имиња ако го користат 
=head1 ОПИС

Геометрија:: Кругот управува со кругови. Обезбедени се методи за создавање
кругови и пресметување на нивните области.
Ова е опис на модулот.

Треба да биде напишано во термини што се релевантни за корисникот, а не од програмерот

.

  • Што прави тоа за корисникот?
  • Како го користите?
  • Кои предмети ги поддржува?
  • Кои методи ги обезбедува? 
=head1 МЕТОДИ

=head2 Создавање

=over 4

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

Создава и враќа а
нова геометрија :: Цел на кругот
со центар ($ x, $ y) и радиус $radius.

=back

=head2 Access

=over 4

=item $circle->center

Враќа список на x, y координати
на центарот на кругот.

Во скаларен контекст,
враќа референца за низа.

=item $circle->radius

Го враќа радиусот на кругот.

=item $circle->area

Ја враќа областа на кругот.

=back
Делот METHODS наведува и опишува секој метод во часот.

Можете дополнително да организирате методи под наслови на ниво 2, како што се создавање, пристап и комунални услуги

. 

=head1 РАЗВОЈ НА КЛАС

=over 4

=item $Geometry::Circle::PI

Односот на обемот од круг до неговиот дијаметар.

=back
Делот CLASS VARIABLES ги наведува сите варијабли на пакетот во API. 
=head1 ДИЈАГНОСТИКА

=over 4

=item Negative radius

(F) Може да се создаде круг со негативен радиус.

=back
Делот ДИЈАГНОСТИКА го дава текстот на секоја порака за грешка што модулот може да ја генерира и го објаснува неговото значење.

Пораките за грешки се класифицирани на следниов начин:
(W)
Предупредување (изборен)
(D)
Амортизација (изборен)
(S)
Тешко предупредување (задолжително)
(F)
Фатална грешка (стапивна)
(X)
Многу фатална грешка (неповторлив) 
=head1 AUTHOR

A. U. Thor, [email protected]
Треба да ги вклучите вашето име и адреса на е-пошта, во случај некој да ве контактира во врска со модулот. 
=head1 SEE ALSO

perl(1), Geometry::Square
Ова е вообичаен список на поврзани програми и модули. 
=cut
На =cut линија означува крај на текст ПОД.

Некои луѓе дистрибуираат ПОД-секции низ нивниот изворен код. Перл ги препознава секциите POD и ги игнорира.

Creative Commons License
Оваа работа е лиценцирана под Меѓународна лиценца Криејтив комонс Наведи извор 4.0.
Steven W. McDougall / resume / [email protected] / 2 јуни 1997 година