Professional Documents
Culture Documents
19-01-2014
0.0.1
Departamento de TI
Neptuno SAC
Reglas Generales
1. La herramienta de desarrollo IDE que se utilizar es Netbeans por ser una
herramienta libre y con funcionalidades tales como: intellisence (autocompletar),
detector de sintaxis, funcionalidades de edicin avanzadas como bsquedas y
reemplazos en todo el proyecto entre otras que sern de gran ayuda durante la
codificacin; el instalador de la versin ms reciente puede descargarse desde:
http://netbeans.org/downloads/index.html
2. La nica persona responsable de agregar recursos tales como iconos, libreras
externas, imgenes, etc. es el administrador de recursos. Si necesita algo que no
lo tenemos pngase en contacto con sta persona.
3. Si necesita alguna funcin para un propsito general y no existe dentro del
archivo general, deber ponerse en contacto con el administrador de recursos
para su implementacin.
4. Las validaciones de formularios (ingreso de datos) cuya informacin es relevante,
se debe hacer tambin desde el lado del servidor debido a que existen
herramientas que permiten saltar las validaciones desde lado del cliente con
javascript, por ejemplo en Mozilla Firefox mediante Firebug se puede cambiar las
propiedades de los objetos, quitar fracciones de cdigo javascript, anular
validaciones de ciertos objetos de los formularios, etc.
5. Queda totalmente prohibido el uso de herramientas no aprobadas por la jefatura.
6. Si desconoce algo, solicite apoyo a su compaero.
7. En lo posible trate de mantener un ambiente de armona y trate de llevarse bien
con todos.
Departamento de TI
Neptuno SAC
Dnde:
app: Carpeta que contiene todos los archivos de la aplicacin.
app/class: Contiene las carpetas de cada mdulo; y estos a su vez contienen
los archivos de clase de cada uno de ellos; considerando que casi siempre se
crear una clase por cada tabla del modelo de base datos, aunque
principalmente para las tablas maestras. Por ejemplo:
app/class/gen : Contiene las clases comunes para la aplicacin.
app/class/ven : Contiene las clases para el mdulo de ventas.
css: Contiene los archivos de hojas de estilo que no estn directamente
relacionado con el diseo.
Departamento de TI
Neptuno SAC
Departamento de TI
Neptuno SAC
Convenciones de Codificacin
1. Declarar las variables de usuario
Como regla general, todas las variables de usuario debern ser declaradas antes de
utilizarlas, por ejemplo el siguiente ejemplo es incorrecto
<?php
if(isset($_SESSION[usuario])){
$mensaje = Si existe;
}
else{
$mensaje = No existe;
}
echo $mensaje;
?>
echo $mensaje;
?>
Departamento de TI
Neptuno SAC
$codigo = $_REQUEST[cod];
?>
3. Indentar el cdigo
Es una buena costumbre aplicar sangras al cdigo para facilitar la lectura del mismo,
por ello se recomienda utilizar una herramienta de desarrollo como Netbeans para
hacer sta tarea en forma rpida.
Como regla, se deber utilizar el estilo K&R1, donde la caracterstica ms resaltante
es que las llaves se abren en la misma lnea de declaracin de la orden, indentando
los siguientes pasos al mismo nivel que la llave y cerrando la llave en el mismo nivel
que la declaracin.
Se debern utilizar 4 espacios para las tabulaciones; por ello s est empleando una
herramienta de desarrollo como Netbeans se recomienda realizar la configuracin
respectiva.
Veamos un ejemplo:
function saludar($val){
if($val == 1) {
echo Hola!;
} else {
echo Chau!;
}
}
El estilo K&R, fue llamado de esta forma porque fue usado por Kernighan y Ritchies en su libro The C
Programming Language. Se trata de abrir la llave en la misma lnea de declaracin de la orden, indentando
los siguientes pasos al mismo nivel que la llave y cerrando la llave en el mismo nivel que la declaracin.
6
Departamento de TI
Neptuno SAC
Ejemplos:
<?php
$saludo = Hola a todos;
$codigo = A-100;
$apellidoPaterno = $_REQUEST[txtApellidoPaterno];
for($i=1; $i<=10; $i++){
echo contando ->.$i;
}
$suma = 0.00;
$total = 0;
?>
Departamento de TI
Neptuno SAC
<?php
class persona {
public function __construct() {
}
public function __destruct() {
}
public function agregarPersona(
$dni,
$apellidoPaterno,
$apellidoMaterno,
$email) {
}
}
?>
otro ejemplo:
<?php
class tramiteDocumentario {
public function __construct() {
}
public function __destruct() {
}
public function consultarDocumento($idDocumento) {
}
public function registarDocumento($data) {
.
.
.
$sql = CALL tra_registrarDocumento(
.$data[unoperOrigen].,
.$data[unoperDestino].,
.$data[usuarioOrigen].,
.$data[usuarioDestino].);
.
$result = mysqli_query($link, $sql);
.
}
}
?>
En lo posible emplear nombres de variables que tengan relacin con el tipo de datos
que devuelven las consultas por ejemplo en el siguiente cdigo empleamos
Departamento de TI
Neptuno SAC
<?php
class alumno {
public function __construct() {
}
public function __destruct() {
}
public function buscarAlumnos(
$tipoBusqueda,
$buscar) {
}
}
?>
Por ejemplo:
<?php
/* constantes predefinidas */
define(GL_RUTA_SERVIDOR, $_SERVER['DOCUMENT_ROOT']. /cad/);
define(GL_URL_SERVIDOR,
http://.$_SERVER['HTTP_HOST'].
/cad/);
/* variables globales*/
$TITULO_PAGINA = Mantenimiento de Clientes;
?>
Departamento de TI
Neptuno SAC
7. Comentarios
Archivos PHP: Deben emplearse comentarios siempre que sea necesario para
explicar brevemente la funcionalidad y el propsito del archivo php a fin de que el
resto del equipo le sea ms fcil entender el cdigo.
Se recomienda comentar los mtodos de las clases y funciones ms complejas, se
deben incluir comentarios para describir la funcionalidad del mtodo, as mismo
describir brevemente cada uno de los parmetros del mtodo o funcin.
Ejemplos de comentarios:
<?php
/*
Permite eliminar el usuario de la base de datos sin chance
a recuperar la cuenta, se eliminarn todas sus actividades,
contactos y mensajes.
*/
include_once(class/usuario.class.php);
$c_usuario = new usuario();
$existe = $c_usuario>consultarExisteUsuario($_REQUEST[id]);
if($existe){
//eliminar todo el historial de comentarios, contactos
y //mensajes
$result = $c_usuario>eliminarHistorial($_REQUEST[id]);
if($result){
//cargar la pantalla inicial de logeo
header(Location: ../login.php);
}
else{
include_once(mensajes.php);
echo mensajeError(401);
}
}
?>
Archivos Javascript: Considere las mismas reglas de comentarios que los archivos php.
Archivos CSS: Los archivos de hojas de estilos tambin deben comentarse tal como en
los archivos php y javascript, se recomienda organizar las hojas de estilos en bloques de
tal forma que solo sea necesario colocar comentarios al inicio del bloque para indicar la
10
Departamento de TI
Neptuno SAC
11