Desarrollar un programa que permita la gestión de una empresa agroalimentaria en lenguaje java

Purpose

Desarrollar un programa que permita la gestión de una empresa agroalimentaria en lenguaje java.

Description

• Contabilizar líneas de código físicas.
• Descartar sangrías y espacios en blanco.
• Contabilizar únicamente comentarios simples
• Establecer nomenclatura bien definida para métodos, variables, etc.

Program Headers

Ingresar: Nombre del desarrollador, Nombre del proyecto, Fecha de creación, funcionalidad

Header Example

//(******************************************************)

//(*        Autor: Erick Vladimir Silva Plascencia                 *)

//(*     Programa: Examen                                                *)

//(* Fecha inicio: 20/10/2015                                      *)

//(*Funcionalidad: Gestionar una empresa agroalimentaria*)

//(******************************************************)

Contents

Contents

Example

Contenido:

Uso de librerías

Inicialización de encabezado de programa

Declaración de parámetros

Declaración cd argumentos a utilizar dentro del programa

Declaración de métodos y funciones

Uso de métodos y funciones

Código reutilizable

Identifiers

Uso y estandarización de la nomenclatura utilizada para un identificador, variable, constante etc. únicamente con la primera letra en mayuscula, deberá de asignarse un nombre alusivo al metodo o funcionalidad a implementar en el programa.

Identifier Example

public class Productos {

        Scanner sc = new Scanner(System.in);

        String fechadecaducidad;

        String numerodelote;

Comments

• Documentar líneas de código para conocer la funcionalidad del programa  
• Dar a conocer el propósito de cada método o clase utilizados en el programa
• Comentar la declaración de toda variable y constante.

Comment Example

void pedir_informacion(){        //comienza el método pedir_informacion

                System.out.println("Ingresa la fecha de caducidad:");                                   //Se pide la fecha de caducidad        

                String s1;                //Se declara variable s1

                s1 = sc.nextLine();        //igualamos la variable s1 con sc

Major Sections

Evidenciar el inicio y fin de una sección del programa con la finalidad de tener un panorama general de la funcionalidad.

Example

                                                                                //A continuación se muestra la clase principal y el método principal                                                                                //se crea un objeto y se llama un método.

public class Test {        

                                  //Inicia la clase principal Test

        public static void main(String[] args) {

                           //Inicia el método principal

                Menu m = new Menu();                                                                    //Se crea un objeto de la clase Menu

                m.menu();        //El objeto menu llama el método menu()

        }                //Se cierra el método principal

}                        //Se cierra la clase principal Test

Indenting

• Aplicar formato al código (ctrl+shift+f) con los espacios definidos, sangrías, etc
• Verificar que para cada control de apertura y cierre de llaves se realice adecuadamente.

Indenting

Example

public class Test {

        public static void main(String[] args) {

                Menu m = new Menu();

                m.menu();

        }

}