Существуют ли какие-либо соглашения по написанию POD-комментариев для Perl?

Question

Мне удалось найти страницу в Safari Books Онлайн, которая предоставляет шаблон, но поскольку я никогда не писал комментарии к POD, я не уверен, насколько он хорош или в нем отсутствует что-либо, что можно было бы считать включенным в соглашение.

Каким соглашениям следует следовать при написании POD-комментариев для Perl-скриптов?Есть ли что-нибудь подобное Соглашения Sun о Javadoc, но для комментариев POD?

Answer 1

Это не сложно, но мне нравится у Джуэрда перлподтут много знакомился.

Автор упоминает, какие разделы он считает общими и что они будут включать.

Answer 2

Существует набор рекомендаций в Лучшие практики Perl.Вся глава 7 посвящена документации, использованию POD и наилучшим подходам к документации для модулей, крупных проектов и т.д.В нем также говорится о соглашениях CPAN.Вероятно, это ваш лучший выбор.

Answer 3

Perl::Критик предоставляет следующие политики:

• Perl::Критик::Политика:: Документация:: Подзапись

• Perl::Критик::Политика::Документация::RequirePackageMatchesPodName

• Perl::Критик::Политика::Документация::Требуется добавить

• Perl::Критик::Политика::Документация::Требуются разделы

Список обязательных разделов это предусмотрено последней политикой, приведенной выше.

Модуль::Стартер::PBP сгенерирует для вас шаблонный код.

Answer 4

Вы можете посмотреть модуль Perl на Поиск по CPAN и быстро обратите внимание на то, что делают все.Различные инструменты запуска модулей создают для вас шаблон.

Это примерно то же самое, что вы можете сказать о руководящих принципах.