Простая старая документация

Материал из Seo Wiki - Поисковая Оптимизация и Программирование

Перейти к: навигация, поиск

Простая старая документация (англ. Plain old documentation, сокращённо pod) — простой язык разметки, применяемый для документирования языка программирования Перл.

Устройство

pod разработан как простой и ясный язык с минимально необходимым полезным синтаксисом. Из него намеренно исключены механизмы для описания шрифтов, изображений, цветов или таблиц. Основными целями разработки pod являются:

  • Простота разбора
  • Простота преобразования в другие форматы и языки, нарпимер в HTML или TeX
  • Простота включения примеров с кодом
  • Простота чтения в исходной форме, то есть без обработки программами форматирования
  • Простота написания (иначе программисты не станут писать документацию!)

Хотя авторы руководоства perlpod отмечают, что возможностей pod скорее всего недостаточно для написания на нём книг[1], фактически есть книги, написанные в расширенной версии pod. Эта расширенная версия включает в себя возможности для форматирования таблиц и подстрочных примечаний и использовалась издтельством O'Reilly & Associates для производства нескольких книг о перле (наиболее известная из них это Программирование на Perl[2] Ларри Уолла, Тома Кристиансена и Джона Орванта). Еще одна расширенная версия pod, называемая mod, использовалась при написании книги en:Higher-Order Perl Марка Джейсона Доминуса.

Примечания

  1. «The Pod format is not necessarily sufficient for writing a book», [1]
  2. Ларри Уолл, Том Кристиансен, Джон Орвант Программирование на Perl = Programming Perl. — «Символ-Плюс», 2006. — С. 1152. — ISBN 5-93286-020-0

de:Plain Old Documentation en:Plain Old Documentation fi:Plain Old Documentation fr:Plain Old Documentation ja:Plain Old Documentation nl:Plain Old Documentation

Личные инструменты

Served in 0.093 secs.