Estandar Documentacion PHP

COMO DOCUMENTAR EL CODIGO PHP
Que hace el sistema en su totalidad. Cuantos módulos en total componen en el sistema. Como se divide cada módulo. Que hace cada parte del modulo dividido. *Parámetros de entrada o sobre que parámetros trabaja. Con que html esta relacionado cada php. Que base de datos utiliza.

Todo tiene que estar comentado antes del comienzo de la porción del código a documentar.

ESTANDARES DE NOMBRE DE VARIABLES
Todas las variables deben tener un nombre representativo y comenzar con $v.

Las variables que provienen de un formulario del html deben tener la forma $vf_nombre_formulario donde “nombre_formulario”. Las variables locales al código php: Si son el resultado de una consulta $vl_r_nombre_consuta, Si son enteras $vl_i_nombre_variable, Si son del tipo caracter $vl_c_nombre_variable, Sin son cadenas de caracteres $vl_s_nombre_variable, etc.

ESTANDARES DE NOMBRES DE FUNCIONES
Deben comenzar con f_nombre_funcion, “nombre_funcion” deberá se un nombre representativo. Antes de la cabecera de la función debe quedar documentado que hace la función. Si la función tiene parámetros que éstos se pasen en lo posible en un formulario.