Foros del Web » Programando para Internet » PHP »

documentación de código php

Estas en el tema de documentación de código php en el foro de PHP en Foros del Web. hola, alguien podría recomendarme - algún enlace sobre "estándares" para escribir código php (ya he buscado varios, si les interesa los posteo, pero he encontrado ...
  #1 (permalink)  
Antiguo 14/03/2003, 18:36
Avatar de sci-fi  
Fecha de Ingreso: marzo-2002
Mensajes: 157
Antigüedad: 15 años, 9 meses
Puntos: 0
documentación de código php

hola,

alguien podría recomendarme

- algún enlace sobre "estándares" para escribir código php (ya he buscado varios, si les interesa los posteo, pero he encontrado que difieren mucho, y si alguien tiene experiencia con ellos le agradecería si me pudiera comentar algo sobre esto)

- alguna aplicación para realizar documentación de código php?

para lo de documentación, conozco "phpDoc" y "phpDocumentor", -si alguien conoce otro y me lo recomienda-, o si no cuál de estos dos me recomendarían, quien los conozca o haya usado? Yo optaría por "phpDocumentor" (phpdocu.sourceforge.net ), sin embargo me parece que es más usado phpDoc ((phpdoc.de ). Mi opción sería el primero pero quería saber cuál de estos dos me recomendarían

desde ya muchas gracias

saludos
__________________
webdeveloper
http://www.javascripters.com.ar/
diseño web y tecnología
  #2 (permalink)  
Antiguo 15/03/2003, 05:36
 
Fecha de Ingreso: enero-2002
Mensajes: 132
Antigüedad: 15 años, 11 meses
Puntos: 1
no debe

No hay varios "estandares" de php. La única documentación 100% fiable y perfecta de php es www.php.net
Lo demás son historias para no dormir. :-p
__________________
Un saludo, esperando ser de ayuda...
COMUN :stress:

Diseño y Programación
Tierra de Califas
http://www.tecnocodigo.com/dipro/
  #3 (permalink)  
Antiguo 15/03/2003, 09:46
O_O
 
Fecha de Ingreso: enero-2002
Ubicación: Santiago - Chile
Mensajes: 34.417
Antigüedad: 15 años, 11 meses
Puntos: 126
Uno de los "standares" es PEAR:

http://pear.php.net

justamente PHPdoc genera documentación al estilo PEAR .. PHPdocumentar genera para PEAR y otros formatos creo .. Pero todas estas herramientas se basan en que estas programando en OOP y la OOP de por sí ya tiene sus reglas y standares para nombrar tus objetos, tus métodos y demas historias ..

Un saludo,
__________________
Por motivos personales ya no puedo estar con Uds. Fue grato haber compartido todos estos años. Igualmente los seguiré leyendo.
  #4 (permalink)  
Antiguo 15/03/2003, 14:07
Avatar de sci-fi  
Fecha de Ingreso: marzo-2002
Mensajes: 157
Antigüedad: 15 años, 9 meses
Puntos: 0
gracias

muchas gracias Cluster, era justo lo que precisaba
además PEAR es una librería open-source, excelente...

sí es para documentar unas clases..., por eso me refería solamente a la forma de escribir código y no al código en sí...

[comun]
Cita:
No hay varios "estandares" de php. La única documentación 100% fiable y perfecta de php es www.php.net
lo dicho arriba... para escribir código orientado a OOP, sea open-source o no, te conviene (o hace falta si lo vas a hacer open-source) seguir unos estándares para escribir código (que no tiene que ver con el lenguaje, es solamente cómo escribirlo, usar tabulaciones o no, cómo escribir comentarios, etc, todo para hacer el código humanamente legible) a eso me refería con "estándares", si te interesa miralo siguiendo el link que pasó Cluster:

http://pear.php.net/manual/en/standards.php

cómo escribir comentarios es para generar documentación con phpDoc o phpDocumentor, luego, si las clases son open-source, te conviene seguir ciertas reglas para escribir el texto para que pueda verse bien en otros editores... yo había leído en un lado que había que usar tabulaciones para "sangrar" el código... luego que no había que hacer eso, sino utilizar solamente dos espacios... la forma de PEAR es con cuatro espacios... por eso no sabía que regla más convenía seguir... algo que me quedó en claro por el momento es que no hay que usar tabulaciones :)

bueno, muchas gracias y saludos
__________________
webdeveloper
http://www.javascripters.com.ar/
diseño web y tecnología
  #5 (permalink)  
Antiguo 15/03/2003, 14:30
O_O
 
Fecha de Ingreso: enero-2002
Ubicación: Santiago - Chile
Mensajes: 34.417
Antigüedad: 15 años, 11 meses
Puntos: 126
Y a la hora de documentar un método por ejemplo .. hay q decir por ejemplo que parámetros acepta y su tipo (string, array, int .. etc) y los que devuelve (otro string, array, int .. etc ..) ..

Bueno .. eso lo describe bien en PEAR .. Y .. aunque se usen simples funciones "sueltas" (no en una classe) es bueno documentarlas así .. Como ejemplo solo hay q ver el manual de referencia del propio PHP o de cualquier lenguaje en el que se ven las descripciones de cada función ..

Un saludo,
__________________
Por motivos personales ya no puedo estar con Uds. Fue grato haber compartido todos estos años. Igualmente los seguiré leyendo.
Atención: Estás leyendo un tema que no tiene actividad desde hace más de 6 MESES, te recomendamos abrir un Nuevo tema en lugar de responder al actual.
Respuesta




La zona horaria es GMT -6. Ahora son las 14:51.