The Big Documentation Extravaganza

The Big Documentation Extravaganza Stephan Schmidt <schst@php.net> 1&1 Internet AG

Agenda ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

The Speaker ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Why write documentation? ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

More reasons for documentation ,[object Object],[object Object],[object Object],[object Object],[object Object]

Types of documentation ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Documentation must be useful ,[object Object],// increment $i by one $i++; Good: // create a unique cache key for the current request $key = md5(serialize($this->_cacheData)); Comment must add value to your code, otherwise they are wasted bytes.

Creating API documentation ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

A typical DocBlock ,[object Object],[object Object]

History of DocBlocks in PHP ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

phpDocumentor ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

phpDocumentor Tags ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

phpDocumentor ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],$ pear install phpDocumentor

Using the CLI Interface ,[object Object],[object Object],[object Object],[object Object],phpdoc -d /home/schst/pear/pear/XML_Serializer/ -o HTML:frames:earthli -t ./XML_Serializer_Docs

Advanced Features ,[object Object],[object Object],[object Object],[object Object],[object Object]

DoxyGen ,[object Object],[object Object],[object Object],[object Object]

DoxyGen Features ,[object Object],[object Object],[object Object]

DoxyGen Features (cont.) ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Who uses DoxyGen ,[object Object],[object Object],[object Object],[object Object],[object Object]

phpDocumentor vs. DoxyGen ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

DocBook ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

DocBook elements ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

DocBook sample document ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Publishing DocBook ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

peardoc ,[object Object],[object Object],[object Object]

Contributing documentation ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Directory structure ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Contributing documentation ,[object Object],[object Object],<sect1 id="package.xml.xml-util"> <title>XML_Util</title> <para> Collection of often needed methods that help you creating XML documents. </para> &package.xml.xml-util.intro; &package.xml.xml-util.example; </sect1>

Contributing documentation ,[object Object],[object Object],[object Object],[object Object],[object Object]

reStructuredText ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Using DocUtils ,[object Object],[object Object],[object Object],[object Object],[object Object]

An example document ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]

Publishing reST ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],$ rst2html sourcefile targetfile

Other Tools ,[object Object],[object Object],[object Object]

Further reading and downloads ,[object Object],[object Object],[object Object],[object Object]

The End ,[object Object],[object Object],[object Object]

The Big Documentation Extravaganza

Recommandé

Recommandé

Contenu connexe

Tendances

Tendances (20)

En vedette

En vedette (20)

Similaire à The Big Documentation Extravaganza

Similaire à The Big Documentation Extravaganza (20)

Plus de Stephan Schmidt

Plus de Stephan Schmidt (16)

Dernier

Dernier (20)

The Big Documentation Extravaganza