Lo que pasa cuando no documentan cuando trabajan
Enviado por admin el Vie, 20/08/2004 - 02:17.
Clasificado en:
Es MUY recomendable que documenten sus funciones CUANDO LAS ESTAN IMPLENTANDO, y que no ocupen demasiadas variables globales (a lo Nuke). Si no, terminaran como yo:
/**
* Entrega un array con los items solicitados
*
* Ejemplo clásico de lo que ocurre cuando no se documenta a tiempo y cuando
* se ocupan muchas globales:
* no tengo la menor idea de cuales son los settings
* ni cual es la estructura de datos devuelta
* @param array
* @return array
*/
function itemsRs($settings = array()) {
global $admin_sesion, $db, $sql_builder, $aNombreVisibilidad,
$aTablasVisibilidad, $oTipoItem;
// ...
}
Hay que ser honestos por lo menos, creo yo.
- 2715 lecturas

Me parece que a esto nos ocurre a casi todos, nos dejamos llevar por la emoción del momento y nos oblidamos de algo tan importante como documentar los scripts.
Enviar un comentario nuevo