Re: coding standards
| From: | Paul Meagher | Date: | Fri, 05 Jan 2001 14:44:47 +0000 |
| Subject: | Re: coding standards | ||
| References: | 1 2 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-792@lists.php.net to get a copy of this message | ||
> On Fri, Jan 05, 2001 at 02:29:46PM +0200, allan@lodestone.co.za wrote:
> > while we're on the subject of standards, what about the
> >
> > // {{{ myFunction()
> >
> > // }}}
> >
> I must say that I really, really, hate those function folding comments,
> and they set a precedent for the coding standard.
>
> They just decrease the readability of the code for those of us who
> don't use emacs. I mean, if PEAR is going to use those, why not put
> in vim-markup, or ^Ms so that people using Windows Notepad can read
> it more easily?
I'd have to agree with you. I have experimented with embedding xml tag in
my scripts to indicate similiar info.
// <func>myFunction()</func>
or
// <func>myFunction()
//</func>
This can also clutter up your code but at least it would be editor neutral -
you could parse it with a php script to extract the relevant info.
Regards,
Paul Meagher