タグ

ドキュメント生成に関するkodamのブックマーク (1)

  • Plain Old Documentation - Wikipedia

    Plain Old Documentation(POD)は、Perl における単純でプラットフォームに依存しないドキュメンテーションツールである。 POD は必要十分な文法を持つ単純で明快な言語として設計された。書体、画像、色、表などの機構を意図的に排除し、必要な機能だけを持つようにしている。その目的は以下の通りである。 構文解析が簡単である。 他の言語(HTMLTeX)への変換が簡単である。 サンプルコードを含めるのが簡単である。 フォーマッタで整形しなくても(ソースコードのままで)読むのが簡単である。 書くのが簡単である。さもなくばプログラマは文書を書きたがらない。 perlpod の筆者は「POD形式はを書くのには不十分である」と書いているが、PODを拡張した書式でが実際に書かれている。この拡張版PODには表や脚注の機能があり、オライリーメディアから出ているいくつかのPer

    Plain Old Documentation - Wikipedia
  • 1