Re: <literal> or <parameter>?
| From: | Dan Scott | Date: | Fri, 13 May 2005 16:44:57 +0000 |
| Subject: | Re: <literal> or <parameter>? | ||
| References: | 1 2 3 4 5 6 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969368251@lists.php.net to get a copy of this message | ||
On 5/13/05, Cornelia Boenigk <c@cornelia-boenigk.de> wrote:
> Hi all
>
> Just to be sure.
> Which one is the right way to do it?
>
> ...
>
> <methodparam><type>array</type><parameter>assoc_array</parameter></methodparam>
> ...
> <para>
> <function>xy</function> does something with
> <literal>assoc_array</literal> ...
> </para>
>
> ...
>
> <methodparam><type>array</type><parameter>assoc_array</parameter></methodparam>
> ...
> <para>
> <function>xy</function> does something with
> <parameter>assoc_array</parameter> ...
> </para>
>
> Regards
> Conni
>
Hi Conni:
http://doc.php.net/php/dochowto/chapter-skeletons.php
shows the use of
<parameter> in the <variablelist> that contains the parameter
descriptions, so I have been using <parameter> whenever I have
referred to a parameter somewhere else in the doc page. <parameter> is
more specific than <literal>, and I always prefer to be explicit where
possible -- but I'm willing to be corrected by some of the php-doc
folks that have been around a lot longer than me.
Dan