Anda di halaman 1dari 6

Normas de Programacin

Objetivos

Mantener el cdigo y diseo con la misma estructura.

Permitir facilidad de lectura en el cdigo por mantener siempre la


misma sintaxis.

NORMAS

1- El cdigo siempre debe estar indentado, utilizando como


espacio la tecla TAB.
2- Siempre se debe utilizar para abrir y cerrar el cdigo PHP el
siguiente tag <?php ?> NUNCA se debe usar <? ?> o <?= ?>
3- Los condicionales y loops deben estar creados de la siguiente
forma:
Sin espacio entre el condicional y el parntesis y con los
corchetes separados con un espacio abajo.
If()

for()

foreach()

while()
{
}

NUNCA SE DEBE HACER USO DEL DO WHILE.


4- La asignacin con el smbolo -> se debe hacer de la siguiente
forma:
Sin espacio entre cada uno.
$this->modelo->getNames;
5- Todo el cdigo debe ser en ingls y esto incluye: las variables,
funciones, clases, mtodos, modelos, controladores, vistas,
nombres de campos en los formularios, nombres de campos en
la bases de datos, nombres de los archivos, nombres de las
carpetas. Lo nico que es en espaol es lo que ser visible para
el usuario final.
6- Al utilizar framework MVC se debe respetar estrictamente la
condicin MVC es decir NUNCA dentro de un controlador puede
existir aspectos de consultas hacia la base de datos, puesto que
lo mismo debe ir en el modelo, as como tampoco debe existir
cdigo de llamadas dentro de las vistas, solo los condicionales y
loops para realizar los arreglos a mostrar.

7- El nombre del controlador del archivo debe ser en minscula y


el interno en mayscula es decir:
Nombre del archivo: administrator.php
Nombre interno: Class Administrator extends CI_Controller
8- Los nombres de las tablas de la base de datos siempre deben
ser en ingls, todo en minscula y en plura. Es decir:
o categories.
o Users.
Entre otros.
9- Los nombres de los modelos siempre deben ser en ingls,
minscula y en singular, es decir:
o categories_model
o user_model
Entre otros.
10- La

estructura

del

html5

siempre

debe

ser

indentado

utilizando TAB, debe estar bien organizado dejando un espacio


(enter) entre etiquetas es decir:
<div class="col-sm-6">
<div class="carousel-content">
<h1 class="animation animated-item-1">
Lorem ipsum dolor sit amet consectetur adipisicing elit
</h1>
<h2 class="animation animated-item-2">
Accusantium doloremque laudantium totam rem aperiam, eaque
ipsa...
</h2>
<a class="btn-slide animation animated-item-3" href="#">
Read More
</a>
</div>
</div>

11- Las carpetas de las vistas deben organizarse de la siguiente


forma:

view/admin (Debe contener todas las vistas del administrador).


view/front (Debe contener todas las vistas del front).
No se permite crear subcarpetas dentro de admin y front, no se
permite crear otras carpetas, las nicas carpetas del sistema
ser ellas dos para las vistas y dentro llevarn todas las vistas
del admin y front respectivamente.

12- A nivel de cdigo el administrador contar con la siguiente


estructura la cual se debe respetar.
o Controladores:

aboutus

admistrator.

category.

contacus.

product.

users.

Entre otros.
13- La estructura interna de los controladores siempre tendr los
siguientes mtodos:
o index.
o create.
o store.
o destroy.
o update.
o edit.
14- Siempre se debe utilizar BootStrap para el HTML, nunca
html5 nativo u otra librera.
15- Todas las pginas deben ser 100% responsives.
16- En el modelo SIEMPRE se debe utilizar active record nunca
consultas completas.

17- En los controladores nunca puede ir el llamado de las vistas


de header y footer, se deben hacer directamente en la vista
principal.
18- Se debe seguir el mismo patrn de diseo que en la pgina a
utiliza como referencia qruzh.