Что лучший способ состоит в том, чтобы зарегистрировать код Perl? [закрытый]
Используйте Arrays.deepEquals () для многомерных массивов.
7 ответов
Посмотрите внутри почти любой модуль Perl, и Вы будете видеть Простая документация (POD) формат. На Поиск CPAN , при рассмотрении модуля у Вас есть опция просмотра необработанного источника, таким образом, это - один способ, которым можно посмотреть на необработанную переходную приставку, но можно также использовать perldoc из командной строки. -m переключатель показывает Вам файл
perldoc -m Foo::Bar
Или, если Вы хотите найти файл, таким образом, можно посмотреть на него в любимом редакторе, используйте эти -l переключатель для нахождения его:
perldoc -l Foo::Bar
, Как только Вы начинаете документировать свою программу, Вы помещаете Переходную приставку в файл прямо с кодом, или вплетенным в код, таким образом, документация рядом с соответствующими частями, или вначале, середина или конец как один большой блок.
Переходная приставка легко переводится в несколько других форматов, таких как ЛАТЕКС, Постскриптум, HTML, и так далее с переводчиками, которые идут с Perl (pod2latex, pod2ps, pod2html). У меня даже есть переводчик переходной приставки, который переходит к InDesign. Запись Вашего собственного переводчика Переходной приставки легка с Переходная приставка:: Простой , поэтому, если Вы не находите переводчика к своей любимой конечной форме, просто сделайте ее сами.
существует также несколько инструментов, которые можно добавить к набору тестов для проверки Переходной приставки. Эти Тест:: Переходная приставка модуль проверяет на ошибки формата, эти Тест:: Переходная приставка:: Покрытие модуль проверяет, что Вы зарегистрировали каждую подпрограмму и так далее. Вы также могли бы интересоваться моим документация документации Perl .
Это - то, как Mozilla документирует их Perl.
Я определенно рекомендую POD.
POD может также использоваться встроенный с кодом, но я предпочитаю помещать в конце программы после __ КОНЕЦ __ (как рекомендовал Damian Conway в Лучшие практики Perl ).
Взгляд POD:: Сервер & POD:: Веб-сервер , который предоставляет веб-фронтенд всем Вашим ПЕРЕХОДНЫМ ПРИСТАВКАМ.
Не быть чрезмерно зеркально отраженным, но лучший способ зарегистрировать код Perl - тот же путь, как Вы зарегистрировали бы код в любом другом языке.
Что касается определенных инструментов, я использую соединение стандартных встроенных комментариев, переходной приставки для больших блоков документации, где формат, подобный , человек является соответствующим, и TeX как заключительная нейтрализация для документов, которые должны быть большей свободной формой. (И, в духе "того же как любой другой язык", да, я действительно использую переходную приставку для документирования кода не-Perl также.)
Никто не упомянул Умный:: Комментарии ? Это не всегда, что Вы хотите, но хороший при необходимости в большем количестве питания к комментариям.
Вы могли бы также хотеть проверить Лучшие практики Perl Damian Conway. Я использовал некоторые подсказки для чистки небольшой кодовой базы Perl, которую я наследовал.
, Какой модуль Вы используете для преобразования переходной приставки в HTML?
Выезд Переходная приставка:: ProjectDocs - Вы получаете простую утилиту командной строки, которая преобразует весь POD в Вашем проекте Perl в ряд страниц HTML, которые смотрят точно так же, как то, что Вы видите на search.cpan.org .