Home > Archive > PHP Documentation > October 2006 > Re: [PHP-DOC] Documenting coding standards
You are viewing an archived Text-only version of the thread.
To view this thread in it's original format and/or if you want to reply to
this thread please [click here]
| Author |
Re: [PHP-DOC] Documenting coding standards
|
|
| Friedhelm Betz 2006-10-15, 9:58 pm |
| Hi,
Etienne Kneuss wrote:
> Hi,
>
> Currently, there is no official coding standards documented on php.net.
> Because of that, the coding standards of PEAR are often referenced in
> discussions.
> It may be useful to document some coding standards: indenting,
> whitespaces, directly on php.net, giving beginners rules/advices to code
> in a way that looks nice.
>
[...]
>
> What do you think ?
We could link to PEAR. In the docs we use the PEAR coding standard for
examples. We should not duplicate the infos from PEAR, imho.
Friedhelm
| |
| Philip Olson 2006-10-16, 6:57 pm |
|
On Oct 15, 2006, at 7:14 PM, Friedhelm Betz wrote:
> Hi,
>
> Etienne Kneuss wrote:
>
> [...]
>
>
> We could link to PEAR. In the docs we use the PEAR coding standard
> for examples. We should not duplicate the infos from PEAR, imho.
How about having the tutorial briefly talk about it (why it's good to
do), and link to the PEAR coding standard.
Regards,
Philip
| |
| Friedhelm Betz 2006-10-16, 6:57 pm |
| Hi,
Philip Olson wrote:
[...]
>
> How about having the tutorial briefly talk about it (why it's good to
> do), and link to the PEAR coding standard.
Fine with me. Talking about coding standards in general and *briefly*,
linking to PEAR is fine with me ;-)
And to go one step further: talking about documenting sourcecode and
link to phpdocumentor?
Seems a good idea to me ;-)
Maybe in "Hints and Tips" ...
Friedhelm
|
|
|
|
|