Re: coding standards
| From: | Anil Madhavapeddy | Date: | Fri, 05 Jan 2001 14:01:31 +0000 |
| Subject: | Re: coding standards | ||
| References: | 1 | Groups: | php.pear |
| Request: | Send a blank email to php-pear+get-788@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()
>
> // }}}
>
> lines ? Most of the files use it, but not all. I'm not personally an emacs
> user but I can see that leaving them in for emacs'ers would be a good idea -
> this folding thing looks pretty funky. Hey, I may even become a convert :)
> And to maintain a standard look across all the files I think we should have
> them in as a standard.
>
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?
PHP has extended well beyond UNIX now, into Windows-land, and it seems
a bit silly to cater to one particular editor. Granted, this is getting
into religious grounds, but can anyone object to just keeping the class
format as simple as possible? It would make converting libraries from
external -> PEAR format a lot simpler as well.
However, if they have a use that I am unaware of, apart from emacs
(perhaps to help phpdoc, or a phplint, etc), then I'd probably have
less objection.
--
Anil Madhavapeddy, <anil@recoil.org>