Re: [Grouptime-developers] RE: The pre-FINAL of Coding Standards

[Cosimo V. <co...@da...>]

Il sab, 2002-09-07 alle 17:52, Jan Urva ha scritto:
> A) Are we sure we want to use spaces (2) instead of tabs?
>    Using tabs let anyone edit (and see) files as preferred
>    (just setting tab indentation inside editor), using
>    spaces doesn't.
> Yes, i'm sure i want to use 2 spaces, because usually the tabs are
> very different lenght in different users and it ends up kind of a
> messy doc. After a while, noone want's to see such crappy idented
> files. So - 2 spaces stays.

For me it's ok, but tabs are client-dependent.
So you see what you want to see.
With spaces you see what "I" want you to see.
No problem for me, but it's not a nice standard in my opinion.


> B) Any file of the project should also have, IMO, the following
>    rows:
>  *  This program is free software; you can redistribute it and/or modify
>  *  it under the terms of the GNU General Public License as published by
>  *  the Free Software Foundation; either version 2 of the License, or
>  *  (at your option) any later version.
>  *
>  *  This program is distributed in the hope that it will be useful,
>  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
>  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
>  *  GNU General Public License for more details.
>  *
>  *  You should have received a copy of the GNU General Public License
>  *  along with this program; if not, write to the Free Software
>  *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
>  *
>  * (See the included file COPYING)
> Agreed in some part, i think that we don't need to add it to the EVERY
> file beginning, because we add the full licence text anyway with the
> product. But maybe these lines should be added in the beginning of the
> initial file (in our case index.php)!?
> 

Have to see, I'm not sure....


> Also a little addition of this template engine we've been discussing. All
> fine, but i'd like to see the template tags like following:
> {TMPL_VAR NAME=XXXXX}

TMPL tags are that way for two reasons:
A) HTML IDE software (Dreamweaver and so on) ignore those tags 
as they are between "<" and ">". So you can edit this template
files with these applications without damaging layout.
B) In case, one or more of this variables, are not passed to the
templates the browser will ignore this tags (they won't be displayed).

> Also, maybe method names should be renamed so, that they fit to our
> standard, i.e:
> setName($template_name)
> openLog($logfile, $loglevel)
> closeLog()
> setOpenTag($open_tag)
> setExtensions($ext)
> setClassPath($path)
> setClassName($name)
> forceCompilation()
> setParam($var, $value)
> getOutput()

No problem, except for "getOutput()".
Why "get" ? The output method will let you have html on standard
output, you can't get it. But it's only my opinion.


> What do you guys think!?
> With regards,
>     Jan

Cosimo.