p6doc — Perl6's «perldoc»

Ссылка на HTML-версию этого документа: https://docs.perl6.org/.

(Если вы просматриваете этот репозиторий через GitHub, отображение может быть частично несогласованным, так как используется формат Perl 6 Pod, а GitHub использует Perl 5 POD).

Документация по локализации на китайский язык

Perl6 FAQ

Спасибо за перевод araraloren.

От Perl5 до Perl6: введение

Руководство по переходу с Perl5 на Perl6 — синтаксис

Руководство по переходу с Perl5 на Perl6 — функции

Руководство по переходу с Perl5 на Perl6 — переменные

Руководство по переходу с Perl5 на Perl6 — операторы

От Ruby к Perl6: введение

Установка

Этот модуль можно установить через экосистему модулей Perl6, используя команду:

zef install p6doc

После установки двоичной версии и обеспечения правильного пути выполнения выполните:

p6doc-index build

для создания индекса.

Использование

Можно запустить через каталог установки Rakudo:

./bin/p6doc Str

чтобы просмотреть документацию класса Str, или через

./bin/p6doc Str.split

чтобы увидеть документацию метода split класса Str. Вы можете пропустить часть ./bin, если вы установили этот модуль с помощью Panda или zef. Также можно выполнить

p6doc -f slurp

для просмотра документации стандартных функций в зависимости от скорости вашего жёсткого диска и версии Rakudo это может занять некоторое время.

Создание HTML-документации

В вашем проекте установите необходимые пакеты с помощью следующей команды:

zef --deps-only install .

panda installdeps .       # panda
zef --depsonly install .  # zef

Если вы используете rakudobrew, вы также можете обновить каждый модуль с помощью:

rakudobrew rehash

Также необходимо установить graphviz для создания различных графиков. В системе Debian вы можете сделать это с помощью команды:

sudo apt-get install graphviz

Создайте веб-страницу с документацией с помощью этой команды:

$ make html

После создания страницы вы можете просматривать её локально. Запустите приложение Mojo с помощью программы (Mojolicious):

$ make run

Теперь вы можете перейти по адресу http://localhost:3000 в браузере, чтобы просмотреть документацию.

Примечание: вам необходимо установить Mojolicious, а также nodejs для подсветки кода.

Помощь!

Проект Perl6 не является маленьким проектом, и для документации требуется много усилий. Мы благодарны за любую помощь. Вы можете помочь нам различными способами:

• дополнить документацию классов, ролей, методов или операторов;
• добавить примеры использования к существующей документации;
• отредактировать всю документацию;
• использовать GitHub для сообщения о недостающей документации;
• найти TODO с помощью git grep TODO в этом репозитории и документировать их;
• перевести проект на другие языки.

На странице Проблемы проекта перечислены текущие проблемы и недостающая документация. А в CONTRIBUTING.md кратко объясняется, как начать вносить свой вклад.

Ответы на вопросы:

Вопрос: Почему этот текст не встроен в язык Perl6? Ответ: Есть несколько причин:

1. Этот документ не привязан к конкретной версии и не зависит от конкретной версии Perl6.
2. Анализ POD и встраивание в код всё ещё нестабильны, чтобы избежать влияния на выполнение.
3. Независимый от Perl6 репозиторий GitHub позволяет большему количеству людей редактировать и вносить свой вклад.

Вопрос: Нужно ли импортировать методы из superclasses или roles? Ответ: Нет. HTML-версия уже включает все методы superclasses и roles, которые можно изучить с помощью скрипта p6doc.

Вопрос: Какая лицензия у этого проекта? Ответ: Весь код и документация основаны на Artistic License 2.0. См. полный текст в файле LICENSE.

Версия

Я хочу, чтобы p6doc и doc.perl6.org стали основным ресурсом для получения информации о функциях Perl 6, будь то язык, встроенные типы или процедуры. Я хочу, чтобы он был полезен каждому программисту на Perl 6.

— moritz

Я надеюсь, что p6doc и doc.perl6.org станут основным источником информации о Perl 6 для всех, кто хочет узнать о его особенностях, будь то сам язык, встроенные типы и процедуры. Я надеюсь, что он будет полезен каждому программисту Perl 6 и всем, кому нужна информация о Perl 6. — moritz

Желаемый формат:

• Реализация Perl6 через встраивание P<...> в исходный код в качестве соответствующего входа p6doc, что позволит динамически получать документацию, например, &say.WHY. Это избавит от необходимости копировать эту документацию в CORE.setting или кодировать её в двоичный файл. Например:

   # In Rakudo's src/core/IO.pm:
  
   #= P<p6doc/&print>
   sub print(|$) { ... }
  
   #= P<p6doc/&say>
   sub say(|$) { ... }
  
   #= P<p6doc/&note>
   sub note(|$) { ... }

LICENSE

См. файл LICENSE для получения подробной информации о лицензии на код в этом репозитории.

Этот репозиторий также содержит код, созданный третьими лицами, который может быть лицензирован по другой лицензии. Такие файлы указывают авторские права и условия лицензии в верхней части файла. В настоящее время они включают:

• Библиотеки jQuery и jQuery UI: Copyright 2015 jQuery Foundation и другие участники; MIT License
• Плагин jQuery Cookie: Copyright 2006, 2015 Klaus Hartl & Fagner Brack; MIT License
• Примеры со Stack Overflow MIT License; (ref #1 for 1f7cc4e)