Los estándares de desarrollo constituyen las normas o patrones de referencia que se deben implementar en el desarrollo de aplicaciones de software. Entre los estándares de desarrollo más comunes se encuentran: normas de codificación, normas y esquemas de seguridad, estándares de interfaz u/s, entre otros.
En el desarrollo del Sistema de Simulación se implementarán algunos estándares básicos para su codificación, los cuales contemplan lo establecido en la PEP-8 (Guía de estilo para código python):
"""
SICP - Simulador Integral de Cadenas Productivas
Copyright (C) 2015 CENDITEL nodo Mérida http://www.cenditel.gob.ve
Fundación Centro Nacional de Desarrollo e Investigación en Tecnologías Libres
Este programa es software libre; Usted puede usarlo bajo los términos de la
licencia de software GPL versión 2.0 de la Free Software Foundation.
Este programa se distribuye con la esperanza de que sea útil, pero SIN
NINGUNA GARANTÍA; tampoco las implícitas garantías de MERCANTILIDAD o
ADECUACIÓN A UN PROPÓSITO PARTICULAR.
Consulte la licencia GPL para mas detalles. Usted debe recibir una copia
de la GPL junto con este programa; si no, escriba a la Free Software
Foundation Inc. 51 Franklin Street,5 Piso, Boston, MA 02110-1301, USA.
"""
"""
@note <Descripción detallada sobre el objetivo de la clase>
@licence <Tipo de licencia de la clase>
@organization <Nombre de la institución u organización que desarrolla la clase>
@author <Nombre del autor que desarrolló la clase. En caso de ser varios autores, incorporar una línea con @author para cada uno de ellos>
@contact <Dirección de contacto de la persona que desarrolla la clase. El formato es nombre at dominio.com>
@date <Fecha en la que se crea la clase. En caso de modificación de la misma se incorporarán líneas adicionales con @date. El formato de fecha es YYYY-MM-DD>
"""
#Descripción sobre el atributo de la clase que se esta declarando
atributo = <valor_por_defecto_del_atributo>
"""
@note <Descripción detallada del método o función>
@licence <Licencia bajo la cual se distribuye el método o función>
@author <Autor que desarrollo la función>
@contact <Dirección de contacto del autor. Ej. nombre at dominio.com>
@param <Parámetro que recibe el método o función. Agregar tantos @param como parámetros contenga la función>
@return <Registros que retorna el método o función en caso de poseerlos, de lo contrario no se coloca este ítem dentro del comentario>
"""
"""
<Descripción de una documentación extensa que plantee de manera detallada el proceso. Esta documentación debe comprender varias líneas>
"""
o
#<Descripción precisa del procedimiento en una sola línea>
/**
* <Descripción detallada de la función>
*
* @author <nombre de la persona que crea la función>
* @param <nombre del parámetro que recibe la función> <Descripción breve del tipo de valor recibido>
* @date <Fecha de creación de la función>
* @return <descripción del valor o procedimiento que retorna la función>
*/
/**
* @style <Descripción de la hoja de estilos>
* @media <Nombre del dispositivo de medios a utilizar para la hoja de estilo. Los valores son: screen|print|all>
* @version <Número de versión de la hoja de estilo>
* @author <Nombre del autor>
* @date <Fecha de creación de la hoja de estilo. El formato es YYYY-MM-DD>
*/
/**
* @section <nombre corto de la sección a describir>
*
* <Descripción detallada de la sección>
*/