[Biophp-dev] Standards
Andrés Pinzón
biophp-dev@bioinformatics.org
Fri, 25 Apr 2003 21:57:30 -0500
This is a multi-part message in MIME format.
------=_NextPart_000_0007_01C30B75.AB24A310
Content-Type: text/plain;
charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
Hi everyone!
FIRST OF ALL xcuseme if this has ALREADY been discussed..i just don`t =
know it!
I've been thinking that maybe it would be OK if
we stop for a moment and think about some "standards",i mean,
1)why don't we try to give some parameters to the code?
and...
2)Why don't we try to post the code at CVS under other parameters (as =
someone else already said!)different from developer?
3) Why don't we try to choose what are we gonna develop based on the =
classes posted at the BIOPHP web page?
How`s the deal?..............
Ok. As we are supossed to be watching at someone else code, it would be =
easier to write the code
in a way that everyone can easily interpret, for example:
-------------------------------------------------------------------------=
---------------
"Rule 1"
-All variables and properties must begin in capital letters as =
follows:
$Variable
...if the variable or propertie has two or more words, each one =
must begin the same way, as follows:
$MyVariable
$MySecondVariable
...and never like:
$My_variable or
$My_Second_Variable
...that will be the way to name classes and functions (I MEAN =
WITH UNDERSCORE)!
-------------------------------------------------------------------------=
----------------
"Rule 2"
- All "{" or "}" in a loop or function must begin and end in a =
new line,as follows:
for("whatever")
{
CODE-HERE;
}
...and never like this:
for("whatever"){
CODE-HERE;}
...OR OTHER VARIANT!
-------------------------------------------------------------------------=
------------------
"Rule 3"
-All scripts must begin with a long comment at top as follows:
#######################
#
# Description, version, author, etc...
#
#
#######################
-------------------------------------------------------------------------=
------------------
I think this is a good idea and can be helpful in the near future! IF U =
don't agree tell me why please!
The other 2 points should be disscussed also, this is just my first =
clear opinion, please comments!
See u
Andres
------=_NextPart_000_0007_01C30B75.AB24A310
Content-Type: text/html;
charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML><HEAD>
<META http-equiv=3DContent-Type content=3D"text/html; =
charset=3Diso-8859-1">
<META content=3D"MSHTML 6.00.2600.0" name=3DGENERATOR>
<STYLE></STYLE>
</HEAD>
<BODY bgColor=3D#ffffff>
<DIV><FONT face=3D"Courier New" color=3D#000080 size=3D2> Hi=20
everyone!<BR> FIRST OF ALL xcuseme if this has ALREADY been =
discussed..i=20
just don`t know it!</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080 size=3D2> I've been =
thinking that=20
maybe it would be OK if<BR> we stop for a moment and think about =
some=20
"standards",i mean,<BR> 1)why don't we try to give some parameters =
to the=20
code?<BR> and...<BR> 2)Why don't we try to post the code at =
CVS under=20
other parameters (as someone else already said!)different from=20
developer?<BR> 3) Why don't we try to choose what are we gonna =
develop=20
based on the classes posted at the BIOPHP web page?</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080 size=3D2> How`s the =
deal?..............</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080 size=3D2> Ok. As we =
are supossed=20
to be watching at someone else code, it would be easier to write the=20
code<BR> in a way that everyone can easily interpret, for=20
example:<BR>-------------------------------------------------------------=
---------------------------<BR> "Rule=20
1"<BR> -All variables and properties =
must=20
begin in capital letters as=20
follows:<BR> &=
nbsp;=20
$Variable<BR> ...if the =
variable or=20
propertie has two or more words, each one must begin the same way, as=20
follows:<BR> &=
nbsp; =20
$MyVariable<BR> &nbs=
p; =20
$MySecondVariable<BR> ...and =
never=20
like:<BR> &nbs=
p; =20
$My_variable=20
or<BR> &=
nbsp; =20
$My_Second_Variable<BR> =
...that will=20
be the way to name classes and functions (I MEAN WITH=20
UNDERSCORE)!<BR>---------------------------------------------------------=
--------------------------------<BR> "Rule=20
2"<BR> - All "{" or "}" in a loop or =
function must begin and end in a new line,as follows:</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080=20
size=3D2> =20
for("whatever")<BR> =20
{<BR> &n=
bsp; =20
CODE-HERE;<BR> =
}</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080=20
size=3D2> ...and never =
like=20
this:</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080=20
size=3D2> =20
for("whatever"){<BR> =20
CODE-HERE;}<BR> ...OR =
OTHER=20
VARIANT!<BR>-------------------------------------------------------------=
------------------------------<BR>"Rule=20
3"<BR> -All scripts must begin with a long =
comment=20
at top as follows:</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080=20
size=3D2> =20
#######################<BR> =20
#<BR> # Description, version, =
author, =20
etc...<BR> =
#<BR> =20
#<BR> #######################</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080=20
size=3D2>----------------------------------------------------------------=
---------------------------<BR>I=20
think this is a good idea and can be helpful in the near future! IF U =
don't=20
agree tell me why please!</FONT></DIV>
<DIV> </DIV>
<DIV><FONT face=3D"Courier New" color=3D#000080 size=3D2>The other 2 =
points should be=20
disscussed also, this is just my first clear opinion, please =
comments!<BR>See=20
u<BR>Andres</FONT></DIV></BODY></HTML>
------=_NextPart_000_0007_01C30B75.AB24A310--