Estandares de codificación para soluciones veterinarias online (SVO)

[pic 1][pic 2]

Diana Isabel Barón Gómez

Código: 1012403494

Ficha de Caracterización: 2455277

Tutor: Henry Torres Pertuz

        Servicio Nacional de Aprendizaje (SENA)

TABLA DE CONTENIDO

TABLA DE CONTENIDO        1

INTRODUCCIÓN        2

OBJETIVO        2

ESTANDARES DE CODIFICACIÓN PARA SOLUCIONES VETERINARIAS ONLINE (SVO)        3

VARIABLES        3

CLASES        3

METODOS        4

EJEMPLOS DE VARIABLES QUE SE PODRIAN UTILIZAR EN EL PROYECTO        4

EJEMPLOS DE CLASES QUE SE PODRIAN UTILIZAR EN EL PROYECTO        5

EJEMPLOS DE METODOS QUE SE PODRIAN UTILIZAR EN EL PROYECTO        5

INTRODUCCIÓN

Por medio de este trabajo conoceremos los estándares de codificación relacionados con elementos clave en la programación, como variables, clases, métodos y otros componentes esenciales en la estructura de un programa.

OBJETIVO

• Promover la aplicación efectiva de estándares de codificación en el desarrollo de software. Manejando un enfoque integral en variables, clases, métodos y otros elementos clave del código.

ESTANDARES DE CODIFICACIÓN PARA SOLUCIONES VETERINARIAS ONLINE (SVO)

Este software es una plataforma integral para veterinarios y dueños de mascotas, que ofrece servicios de tienda online, asignación de citas veterinarias y de especialista en línea, Spa canino, registro e inicio de sesión de usuarios para un seguimiento de solicitudes más integral y un proceso de facturación para los servicios prestados.

El uso de los correctos estándares de codificación en este proyecto es fundamental para asegurar la calidad del código mejorar la accesibilidad y mantenibilidad del software.

VARIABLES

• Todas las variables deben tener nombres descriptivos que reflejen su propósito y contenido. Por ejemplo, en lugar de usar nombres genéricos como “var1” o “let1” se deben utilizar nombres más descriptivos como “médicos”, “fechaCita”, “cantidadProductos”, “artículos”.
• El nombramiento de variables seguirá la convención CamelCase, donde cada palabra dentro del nombre comienza con mayúscula, excepto la primera palabra. Por ejemplo “nombreCliente”, “nombreMascota”, “tipoProducto”, “tipoMascota”.
• Se evitarán abreviaturas ambiguas que puedan generar confusión. En lugar de usar abreviaturas como “tbl” para “tabla” o “svc” para “servicio”, se preferirán nombres completos y descriptivos.

CLASES

• Los nombres de las clases serán descriptivos y en CamelCase, comenzando con una letra mayúscula. Por ejemplo, “CitaVeterinaria”, “ProductoTienda”, “CitaSpa”.
• Las clases se organizarán en paquetes lógicos y coherentes para una fácil navegación y estructura del proyecto.

METODOS

• Los nombres de los métodos deben comenzar con un verbo que indique su acción, seguido de un sustantivo o adjetivo que describa la función. Por ejemplo, “registrarCita”, “actualizarInventario”, “registrarSpa”.
• Se mantendrá coherencia en la nomenclatura de métodos para facilitar su comprensión y uso en el proyecto.

EJEMPLOS DE VARIABLES QUE SE PODRIAN UTILIZAR EN EL PROYECTO

Las siguientes podrían ser algunas de las variables para la tienda online de productos veterinarios

...