On Fri, 30 May 2003, Friedhelm Betz wrote:

> On Friday 30 May 2003 19:20, Gabor Hojtsy wrote:
> > Hi!
> >
> > > I disagree with these changes and don't consider them
> > > upgrades, I intentionally put the output in the
> > > example as to make a clean cut-n-paste example.  In
> > > fact, there are times when I change it the other way
> > > around :)
> > >
> > > Why do you feel using <screen> is "an upgrade"?
> >
> > I guess because that is somewhat in line with the guidelines, maybe...
> > BTW I cannot find thic convention in the howto ;) But I remember to
> > something like that. Anyway, I think this should be dealt with on a case
> > by case basis. Sometimes it is OK to put the output into the code, and
> > sometimes it is not.
> 
> 
> Maybe from RFC/coding_standards:
> 
> <qoute>
> E: EXAMPLE PRINTOUTS
> 
> For short example printouts, use a C++ style comment
> on the line where the output occurs, or the next line,
> where it is needed:
> echo $var; // outputs: 32
> 
> For longer example printouts use the screen
> container in conjunction with <![CDATA[... ]]>:
> ....
> </quote>

Because it's just an RFC made by one person ;)  Also this
did come up once:

  http://marc.theaimsgroup.com/?l=phpdoc&m=103773896617496

Basically, it's a case-by-case basis but both methods
are appropriate.  I prefer inline vs screen in most
cases.

Regards,
Philip


-- 
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

Reply via email to