[PHP-DOC] Writing code examples in PHPDOC From: Jirka Kosek (jirka <email protected>)
Date: 03/12/01

Hi,

as PHP documentation is in XML, everywhere (even in programlistings)
characters < and & must be written as &lt; and &amp;. For longer code
examples it may be appropriate to use CDATA sections - in this section
XML reserved characters are not escaped:

<programlisting role="php"><![CDATA[
if ($foo < $bar)
  echo "Hi!";
]]></programlisting>

With CDATA you should write it as:

<programlisting role="php">
if ($foo &lt; $bar)
  echo "Hi!";
</programlisting>

I'm writing here, because not all php-doc contributors know this XML
feature. Jade is very tolerant to errors like this because it comes from
SGML world. XML tools will crash on errors like these.

-----------------------------------------------------------------
  Jirka Kosek
  e-mail: jirka <email protected>
  http://www.kosek.cz