Como hago la documentacion de mis scripts PHP

[SymarCs]

Buenas ... bueno estoy por acabar un proyecto, solo faltan algunos detalles pero antes de pasar a eso quiero abarcar la parte de documentacion.

La verdad es que no se por donde empezar o que hacer. Espero que me puedan responder esto.

¿Por donde debo empezar?
¿Que pasos debo seguir?
¿Que es importante documentar y que no?
¿Debo seguir algun modelo o metodo?

Por ultimo, alguien me podria pasar un pequño ejemplo de como se hace. Quiero hacer la documentacion no las faqs. Gracias, espero puedan ayudarme.

[eFreelance]

Depende si tu código es un script comun con funciones, o si utilizás orientación a objetos, pero en general lo importante es:

- documentar funciones o clases: para que sirven, que argumentos reciben y que valores retornan.
- documentar algun codigo que sea "confuso".

Lo que NO CONVIENE documentar es el código propiamente dicho. ej:

// sirve para xxxxx
if (!isset($_POST['valor']));

porque se supone que el que lee el codigo ya es programador y sabe para que sirve.
La idea es principalmente documentar funciones y clases ( que argumentos reciben, que valor retornan, como se utilizan, como se instancian, etc)


Podés utilizar http://www.phpdoc.org/ , hay un standard para eso

[SymarCs]

Bueno mis scripts son apartir de funciones, si los tengo de esa manera que metodo debo seguir.

Estoy viendo la posibilidad de pasarlos a Clases para utilizar el phpDocumentor y me ahorre bastante tiempo, pero por ahora solo los tengo asi con funciones (no metodos).